@mocanvas/editor · interface

TLStoreBaseOptions

interface TLStoreBaseOptions

What every way of building a store has in common: the data to start from and where its asset bytes live.

Separate from the *schema* options because the two are chosen independently. A host usually has one schema for the whole application and a different document to open in it every time somebody clicks a file.


Properties · 5

assets?: AssetStore

Where the bytes behind this document's assets live.

Kept by identity, so a caller can compare store.props.assets against what it passed. Defaults to an in-memory store.

defaultName?: string

Name given to the document's first page.

id?: string

Id for the store itself. Useful in a log when a page holds several.

initialData?: SerializedStore<EditorRecord>

Records to start from, as a plain serialized map.

snapshot?: EditorStoreSnapshot

A snapshot to start from, in preference to initialData.

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.