Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tldraw/tldraw
whiteboard / infinite canvas SDK
https://github.com/tldraw/tldraw
canvas collaboration design diagram drawing infinite multiplayer react sketch sync whiteboard
Last synced: 7 days ago
JSON representation
whiteboard / infinite canvas SDK
- Host: GitHub
- URL: https://github.com/tldraw/tldraw
- Owner: tldraw
- License: other
- Created: 2021-05-09T11:48:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T10:24:12.000Z (7 days ago)
- Last Synced: 2025-01-06T10:33:57.960Z (7 days ago)
- Topics: canvas, collaboration, design, diagram, drawing, infinite, multiplayer, react, sketch, sync, whiteboard
- Language: TypeScript
- Homepage: https://tldraw.dev
- Size: 668 MB
- Stars: 38,179
- Watchers: 158
- Forks: 2,335
- Open Issues: 327
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - tldraw/tldraw - SDK for creating whiteboards and canvas experiences on the web. (TypeScript)
- 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 - whiteboard SDK / infinite canvas SDK (TypeScript)
- awesome-star-libs - tldraw / tldraw
- stars - tldraw/tldraw - whiteboard / infinite canvas SDK (⭐️38146) (TypeScript)
- stars - tldraw/tldraw - whiteboard / infinite canvas SDK (⭐️38146) (TypeScript)
README
# 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
corepack enable
```
Install dependencies:
```bash
yarn
```
Start the local development server:
```bash
yarn dev
```
Open the example project at `localhost:5420`.
## 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.gg/rhsyWMUJxd). 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 [[email protected]](mailto:[email protected]).