tldraw

Editor

The Editor class is the main way of controlling tldraw's editor. You can use it to manage the editor's internal state, make changes to the document, or respond to changes that have occurred.

​

Shapes

In tldraw, a shape is something that can exist on the page, like an arrow, an image, or some text.

​

Assets

Assets are dynamic records that store data about a shared asset. For example, the image and video shapes refer to assets rather than embedding their source files directly. This is essential because, by default, these asset sources are stored in base64 data.

​

Tools

In tldraw, a tool is any top-level state in the state chart. For example, the select tool, the draw tool, and the arrow tool are all top-level states that the user can be in.

​

Persistence

Persistence in tldraw means storing information about the editor's state to a database and then restoring it later. There are a few options that developers have for getting data into tldraw and out again.

​

User interface

The user interface in tldraw includes the menus, toolbars, keyboard shortcuts, and analytics events in the editor.

​

Collaboration

The tldraw SDK is designed to work with any collaboration backend. Depending on which backend you choose, you will need an interface that pipes changes coming from the editor to the backend and then merge changes from the backend back to the editor.