Tldraw/packages/tldraw
alex 0bd6410d9f
avoid lazy race conditions (#1364)
We had a few issues with lazy race conditions failing CI. This came from
scripts configured to invoke lazy again, rather than through expressing
dependencies between scripts.

This diff reconfigures lazy to articulate these sorts of things as
dependencies instead of through self-invocation. Instead of having lots
of separate `build-package`, `build-docs`, etc commands, we now just
have a build command with package overrides to express more specific
options

### Change Type
- [x] `internal` — Any other changes that don't affect the published
package (will not publish a new version)

### Release Notes
[internal only]
2023-05-12 15:41:40 +00:00
..
scripts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
src Fix to not ignore the `userId` option for `<Tldraw/>` component in `@tldraw/tldraw` (#1205) 2023-04-27 10:03:21 +00:00
CHANGELOG.md transfer-out: transfer out 2023-04-25 12:01:25 +01:00
LICENSE transfer-out: transfer out 2023-04-25 12:01:25 +01:00
README.md readmes 2023-05-04 13:47:56 +01:00
api-extractor.json transfer-out: transfer out 2023-04-25 12:01:25 +01:00
api-report.md transfer-out: transfer out 2023-04-25 12:01:25 +01:00
package.json avoid lazy race conditions (#1364) 2023-05-12 15:41:40 +00:00
setupTests.js derived presence state (#1204) 2023-04-27 18:03:19 +00:00
tsconfig.json transfer-out: transfer out 2023-04-25 12:01:25 +01:00

README.md

Signia

@tldraw/tldraw

This is the alpha version of tldraw. It is very much a work in progress.

Installation

Install the @tldraw/tldraw package using @alpha for the latest alpha release.

yarn add @tldraw/tldraw@alpha
# or
npm install @tldraw/tldraw@alpha
# or
pnpm i @tldraw/tldraw@alpha

Then start the local development server.

yarn dev
# or
npm run dev
# or
pnpm dev

Usage

An extremely minimal usage (without our UI) might look like this:

import { Tldraw } from '@tldraw/tldraw'
import '@tldraw/tldraw/styles-editor.css'
import '@tldraw/tldraw/styles-ui.css'

export default function () {
	return <Tldraw />
}

See the examples repo for more examples.

License

The source code in this repository (as well as our 2.0+ distributions and releases) are currently licensed under Apache-2.0. These licenses are subject to change in our upcoming 2.0 release. If you are planning to use tldraw in a commercial product, please reach out at hello@tldraw.com.