aa862d2a17
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.
Documentation
Documentation for the most recent release can be found on tldraw.dev/docs, including reference docs. Our release notes can be found here.
For more agent-friendly docs, see our LLMs.txt.
From 5.1.x onward, this package also includes a DOCS.md file with the appropriate docs-site content and a generated RELEASE_NOTES.md file with versioned release notes. If you or your coding agent need release notes for your installed version specifically, check these files alongside the source in your node_modules folder.
Who's using tldraw
The tldraw SDK powers canvas experiences in products from Google, Shopify, BlackRock, Autodesk, ClickUp, Replit, Google Stitch, Luma, Runway, Padlet, Mobbin, Jam, Craft, Honeycomb, SchoolAI, Brisk, and many more. See our showcase for case studies.
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.
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
Found a bug? Please submit an issue.
Community
Have questions, comments or feedback? Join our discord. For the latest news and release notes, visit tldraw.dev.
Contact
Find us on Twitter/X at @tldraw.