History

huppy-bot[bot] 64dce02ba3 Update CHANGELOG.md [skip ci]		2023-12-12 14:50:43 +00:00
..
api	Add fit to content for frames. (#2275 )	2023-12-07 12:57:56 +00:00
scripts	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00
src	Revert "zoom to affected shapes after undo/redo" (#2310 )	2023-12-12 11:36:52 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	Add fit to content for frames. (#2275 )	2023-12-07 12:57:56 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2023-12-12 14:50:43 +00:00
LICENSE	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
package.json	Update CHANGELOG.md [skip ci]	2023-12-12 14:50:43 +00:00
README.md	Update readme (#2027 )	2023-10-06 12:10:33 +00:00
setupTests.js	fix vite HMR issue (#2279 )	2023-12-01 16:48:30 +00:00
tsconfig.json	tldraw zero - package shuffle (#1710 )	2023-07-17 21:22:34 +00:00

README.md

@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.