tldraw SDK
tldraw is an infinite canvas SDK for React developers. You can use the tldraw SDK to add a drop-in whiteboard to your project, customize its appearance, extend its functionality, or use its components and APIs to compose other canvas experiences.
Learn more at our docs site: tldraw.dev.
Installation
Install the tldraw
package.
npm i tldraw
Usage
import { Tldraw } from 'tldraw'
import 'tldraw/tldraw.css'
export default function () {
return <Tldraw />
}
Visit tldraw.dev to learn more.
Package development
To start the local development server:
npm run dev
This will run our examples app locally at http://localhost:5420. Changes to packages will be reflected live on the examples app.
License
This project is part of the tldraw SDK. It is provided under the tldraw SDK license.
You can use the tldraw SDK in commercial or non-commercial projects so long as you preserve the "Made with tldraw" watermark on the canvas. To remove the watermark, you can purchase a business license. Visit tldraw.dev to learn more.
Trademarks
Copyright (c) 2024-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our trademark guidelines for info on acceptable usage.
Distributions
You can find tldraw on npm here.
Contribution
Please see our contributing guide. Found a bug? Please submit an issue.
Have questions, comments or feedback? Join our discord or start a discussion. For the latest news and release notes, visit tldraw.dev.
Contact
Find us on Twitter/X at @tldraw.