Tldraw/packages/tldraw
David Sheldrick a4fff303bf update lazyrepo 2023-06-05 18:32:32 +01:00
..
scripts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
src [refactor] User-facing APIs (#1478) 2023-06-01 15:47:34 +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 [refactor] User-facing APIs (#1478) 2023-06-01 15:47:34 +00:00
package.json update lazyrepo 2023-06-05 18:32:32 +01:00
setupTests.js derived presence state (#1204) 2023-04-27 18:03:19 +00:00
tsconfig.json [refactor] User-facing APIs (#1478) 2023-06-01 15:47:34 +00: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.