This package contains the source code for the tldraw library. Learn more at our docs site: tldraw.dev.
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
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.
Have questions, comments or feedback? Join our discord or start a discussion.
You can find tldraw on npm here.
Please see our contributing guide. Found a bug? Please submit an issue.
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.
Copyright (c) 2023-present tldraw Inc. The tldraw name and logo are trademarks of tldraw. Please see our trademark guidelines for info on acceptable usage.
Find us on Twitter at @tldraw or email hello@tldraw.com. You can also join our discord for quick help and support.
FAQs
A tiny little drawing editor.
The npm package tldraw receives a total of 21,963 weekly downloads. As such, tldraw popularity was classified as popular.
We found that tldraw demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.