Welcome to the developer docs for tldraw, a React library for creating whiteboards and other infinite canvas experiences. These docs are for the 2.0 version which is currently in alpha.
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.
In addition to the docs on this website, we provide many examples in the tldraw repo that demonstrate different ways of using the tldraw library. You can view them running here; or else you can clone the tldraw repo and start a local development server to see them in action.
Found a bug or want to request a feature? Create an issue here. To connect with the team and other users, join us on our Discord. To follow along with updates, you can also subscribe to our Substack newsletter or follow us on Twitter/X.
Our open source libraries are licensed and distributed under Apache-2.0.
Our plan is to keep these libraries permissively licensed while we develop a commercial offering for teams who want more from tldraw. If you're planning to use use tldraw in a commercial product, please reach out at email@example.com.