TldrawEditorWithoutStoreProps

Extends TLStoreBaseOptions.

Props for the Tldraw and TldrawEditor components, when not passing in a TLStore 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[];

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;

Named theme definitions. When provided, custom color names are automatically registered before the store is constructed so persisted data with those colors passes validation on load.

themes?: Partial<TLThemes>;

How should this store resolve users for attribution?

users?: TLUserStore;

Methods

Called when the store is connected to an Editor.

Parameters

Editor;

Returns

(() => void) | void;