TLStoreBaseOptions

See source code
Table of contents
interface TLStoreBaseOptions {}

Properties

assets

optional

How should this store upload & resolve assets?

assets?: TLAssetStore;

defaultName

optional

The default name for the store.

defaultName?: string;

initialData

optional

The initial data for the store.

initialData?: SerializedStore<TLRecord>;

snapshot

optional

A snapshot of initial data to migrate and load into the store.

snapshot?: Partial<TLEditorSnapshot> | TLStoreSnapshot;

themes

optional

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>;

users

optional

How should this store resolve users for attribution?

users?: TLUserStore;

Methods

onMount

optional

Called when the store is connected to an Editor.

Parameters

NameDescription

editor

Editor;

Returns

(() => void) | void;

Prev
TLStateNodeConstructor
Next
TLSvgExportOptions