History

David Sheldrick 9d237eec73 Fix publishing scripts (#3008 ) Follow up to #3006 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [ ] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [x] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - Add a brief release note for your PR here.		2024-02-29 16:59:05 +00:00
..
api	[docs] design shuffle (#2951 )	2024-02-29 16:28:45 +00:00
scripts	tldraw_final_v6_final(old version).docx.pdf (#2998 )	2024-02-29 16:06:19 +00:00
src	Fix publishing scripts (#3008 )	2024-02-29 16:59:05 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	[docs] design shuffle (#2951 )	2024-02-29 16:28:45 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2024-02-29 16:41:45 +00:00
LICENSE.md	Change licenses to tldraw (#2167 )	2023-12-19 10:41:01 +00:00
package.json	Update CHANGELOG.md [skip ci]	2024-02-29 16:41:45 +00:00
README.md	tldraw_final_v6_final(old version).docx.pdf (#2998 )	2024-02-29 16:06:19 +00:00
setupTests.js	reactive context menu overrides (#2697 )	2024-01-31 16:35:49 +00:00
tsconfig.json	Check tsconfig "references" arrays (#2891 )	2024-02-21 13:07:53 +00:00

README.md

tldraw

This package contains the source code for the tldraw library. Learn more at our docs site: tldraw.dev.

Installation

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

yarn add tldraw@canary
# or
npm install tldraw@canary
# or
pnpm i 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'
import 'tldraw/tldraw.css'

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

See the examples folder for more examples.

Community

Have questions, comments or feedback? Join our discord or start a discussion.

Distributions

You can find tldraw on npm here.

Contribution

Please see our contributing guide. Found a bug? Please submit an issue.

License

The tldraw source code and its distributions are provided under the tldraw license. This license does not permit commercial use.

If you wish to use this project in commercial product, you need to purchase a commercial license. Please contact us at hello@tldraw.com for more inforion about obtaining a commercial license.

Trademarks

Contact

Find us on Twitter at @tldraw or email hello@tldraw.com. You can also join our discord for quick help and support.