TldrawEditorWithoutStoreProps

Extends TLStoreBaseOptions.

Props for the Tldraw and TldrawEditor components, when not passing in a directly. If you would like to pass in a store directly, use TldrawEditorWithStoreProps.

interface TldrawEditorWithoutStoreProps extends TLStoreBaseOptions {}

Properties

How should this store upload & resolve assets?

assets?: TLAssetStore

The default name for the store.

defaultName?: string

The initial data for the store.

initialData?: SerializedStore<TLRecord>

Additional migrations to use in the store

migrations?: readonly MigrationSequence[]

Is this store connected to a multiplayer sync server?

multiplayerStatus?: null | Signal<'offline' | 'online'>

Called when the store is connected to an Editor.

onEditorMount?: (editor: Editor) => (() => void) | void

If you would like to persist the store to the browser's local IndexedDB storage and sync it across tabs, provide a key here. Each key represents a single tldraw document.

persistenceKey?: string

sessionId?: string

A starting snapshot of data to pre-populate the store. Do not supply both this and initialData.

snapshot?: TLEditorSnapshot | TLStoreSnapshot

store?: undefined