https://github.com/tldraw/tldraw
whiteboard SDK / infinite canvas SDK
https://github.com/tldraw/tldraw
canvas collaboration design diagram drawing infinite multiplayer react sdk sketch sync whiteboard
Last synced: about 2 months ago
JSON representation
whiteboard SDK / infinite canvas SDK
- Host: GitHub
- URL: https://github.com/tldraw/tldraw
- Owner: tldraw
- License: other
- Created: 2021-05-09T11:48:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T08:55:01.000Z (6 months ago)
- Last Synced: 2025-05-05T15:11:29.013Z (6 months ago)
- Topics: canvas, collaboration, design, diagram, drawing, infinite, multiplayer, react, sdk, sketch, sync, whiteboard
- Language: TypeScript
- Homepage: https://tldraw.dev
- Size: 743 MB
- Stars: 39,938
- Watchers: 156
- Forks: 2,508
- Open Issues: 325
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- my-awesome-list - tldraw
- awesome-front-end-system-design - tldraw
- awesome-codebases - tldraw - a very good whiteboard (**Awesome Codebases** [](https://github.com/sindresorhus/awesome))
- Awesome-GithubRepos - tldraw
- awesome - tldraw/tldraw - very good whiteboard SDK / infinite canvas SDK (TypeScript)
- awesome-star-libs - tldraw / tldraw
- stars - tldraw/tldraw - very good whiteboard SDK / infinite canvas SDK (⭐️43557) (TypeScript)
- stars - tldraw/tldraw - very good whiteboard SDK / infinite canvas SDK (⭐️41319) (TypeScript)
- awesome-rainmana - tldraw/tldraw - very good whiteboard SDK / infinite canvas SDK (TypeScript)
- AiTreasureBox - tldraw/tldraw - 11-03_43645_0](https://img.shields.io/github/stars/tldraw/tldraw.svg)|very good whiteboard SDK / infinite canvas SDK| (Repos)
README
# tldraw
[](https://deepwiki.com/tldraw/tldraw)
Welcome to the public monorepo for [tldraw](https://github.com/tldraw/tldraw). tldraw is a library for creating infinite canvas experiences in React. It's the software behind the digital whiteboard [tldraw.com](https://tldraw.com).
- Read the docs and learn more at [tldraw.dev](https://tldraw.dev).
- Learn about [our license](https://github.com/tldraw/tldraw#License).
> [Click here](https://tldraw.dev/#pricing) to learn about our license and pricing.
## Installation
```bash
npm i tldraw
```
## Usage
```tsx
import { Tldraw } from 'tldraw'
import 'tldraw/tldraw.css'
export default function App() {
return (
)
}
```
Learn more at [tldraw.dev](https://tldraw.dev).
## Local development
The local development server will run our examples app. The basic example will show any changes you've made to the codebase.
To run the local development server, first clone this repo.
Enable [corepack](https://nodejs.org/api/corepack.html) to make sure you have the right version of `yarn`:
```bash
npm i -g corepack
```
Install dependencies:
```bash
yarn
```
Start the local development server:
```bash
yarn dev
```
Open the example project at `localhost:5420`.
## Tips for AIs
**Are you an AI agent?** If so, this monorepo has special `CONTEXT.md` files found throughout the repository that you can use to quickly build context while you work. Use your own tools to find and read these files, or use our helpful `context` script to locate and log the contents of the most relevant files.
To get started quickly, run:
```bash
yarn context
```
This will find and display the nearest CONTEXT.md file to help you understand the codebase. The `context` script supports several options:
- `yarn context` - Show path to nearest CONTEXT.md from current directory
- `yarn context ./foo/bar/baz.ts` - Show path to nearest CONTEXT.md for a specific file or directory
- `yarn context -v` or `--verbose` - Show full content of nearest CONTEXT.md
- `yarn context -r` or `--recursive` - Find all CONTEXT.md files in the repository
## License
The tldraw SDK is provided under the [tldraw license](https://github.com/tldraw/tldraw/blob/main/LICENSE.md).
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](https://tldraw.dev#pricing). Visit [tldraw.dev](https://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](https://github.com/tldraw/tldraw/blob/main/TRADEMARKS.md) for info on acceptable usage.
## Distributions
You can find tldraw on npm [here](https://www.npmjs.com/package/@tldraw/tldraw?activeTab=versions).
## Contribution
Please see our [contributing guide](https://github.com/tldraw/tldraw/blob/main/CONTRIBUTING.md). Found a bug? Please [submit an issue](https://github.com/tldraw/tldraw/issues/new).
## Community
Have questions, comments or feedback? [Join our discord](https://discord.tldraw.com/?utm_source=github&utm_medium=readme&utm_campaign=sociallink). For the latest news and release notes, visit [tldraw.dev](https://tldraw.dev).
## Contributors
## Star History
## Contact
Find us on Twitter/X at [@tldraw](https://twitter.com/tldraw). You can contact us by email at [hello@tldraw.com](mailto:hello@tldraw.com).