TLEditorOptions

interface TLEditorOptions {}

Properties

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[]

Options for the editor's camera.

cameraOptions?: Partial<TLCameraOptions>

fontAssetUrls?: {
  [key: string]: string | undefined
}

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

inferDarkMode?: boolean

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

initialState?: string

licenseKey?: string

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

textOptions?: TLTextOptions

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[]

A user defined externally to replace the default user.

user?: TLUser

Methods

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

Provides a way to hide shapes.

Example

getShapeVisibility={(shape, editor) => shape.meta.hidden ? 'hidden' : 'inherit'}

• 'inherit' | undefined - (default) The shape will be visible unless its parent is hidden.
• 'hidden' - The shape will be hidden.
• 'visible' - The shape will be visible.

Parameters

TLShape

Editor

Returns

'hidden' | 'inherit' | 'visible' | null | undefined