TLEditorOptions • tldraw Docs

Table of contents

interface TLEditorOptions {}

Properties

optional

Whether to automatically focus the editor when it mounts.

autoFocus?: boolean

An array of bindings to use in the editor. These will be used to create and manage bindings in the editor.

bindingUtils: readonly TLAnyBindingUtilConstructor[]

optional

Options for the editor's camera.

cameraOptions?: Partial<TLCameraOptions>

optional

Whether to infer dark mode from the user's system preferences. Defaults to false.

inferDarkMode?: boolean

optional

The editor's initial active tool (or other state node id).

initialState?: string

optional

licenseKey?: string

optional

options?: Partial<TldrawOptions>

An array of shapes to use in the editor. These will be used to create and manage shapes in the editor.

shapeUtils: readonly TLAnyShapeUtilConstructor[]

The Store instance to use for keeping the app's data. This may be prepopulated, e.g. by loading from a server or database.

store: TLStore

An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.

tools: readonly TLStateNodeConstructor[]

optional

A user defined externally to replace the default user.

user?: TLUser

Should return a containing html element which has all the styles applied to the editor. If not given, the body element will be used.

optional

A predicate that should return true if the given shape should be hidden.

Name	Description
`shape`	`TLShape` The shape to check.
`editor`	`Editor` The editor instance.

boolean