tldraw

What is tldraw ?

tldraw is a collaborative digital whiteboard.

You can use the Tldraw React component to embed a fully featured and extendable whiteboard in your app.

For multiplayer whiteboards, you can plug the component into the collaboration backend of your choice. Check out our Yjs example to see how you might use tldraw together with Yjs.

You can use the Editor API to create, update, and delete shapes, control the camera—or do just about anything else. You can extend tldraw with your own custom shapes and custom tools. You can use our user interface overrides to change the contents of menus and toolbars, or else hide the UI and replace it with your own.

If you want to go even deeper, you can use the TldrawEditor component as a more minimal engine without the default tldraw shapes or user interface.

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.

Install dependencies:

yarn

Start the local development server:

yarn dev

Open the example project at localhost:5420.