Tldraw/packages/tldraw
huppy-bot[bot] d38587d215 Update CHANGELOG.md [skip ci] 2023-10-06 15:18:15 +00:00
..
scripts
src
CHANGELOG.md Update CHANGELOG.md [skip ci] 2023-10-06 15:18:15 +00:00
LICENSE
README.md
api-extractor.json
api-report.md
package.json Update CHANGELOG.md [skip ci] 2023-10-06 15:18:15 +00:00
setupTests.js
tsconfig.json

README.md

tldraw

@tldraw/tldraw

This is the pre-release version of tldraw.

See the pre-release docs at canary.tldraw.dev.

Installation

Install the @tldraw/tldraw package using @canary for the latest canary release. (Or @alpha for the latest alpha release.)

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

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/tldraw.css'

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

See the examples folder 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.