TLStoreProps

Configuration properties for a tldraw store, defining its behavior and integrations. These props are passed when creating a new store instance.

interface TLStoreProps {}

Example

const storeProps: TLStoreProps = {
  defaultName: "My Drawing",
  assets: myAssetStore,
  onMount: (editor) => {
    console.log("Editor mounted");
    return () => console.log("Editor unmounted");
  },
  collaboration: {
    status: statusSignal,
    mode: modeSignal,
  },
};

const store = new Store({ schema, props: storeProps });

Properties

Asset store implementation for handling file uploads and storage

assets: Required<TLAssetStore>;

Optional collaboration configuration for multiplayer features

collaboration?: {
  mode?: null | Signal<"readonly" | "readwrite">;
  status: null | Signal<"offline" | "online">;
};

Default name for new documents created in this store

defaultName: string;

User store implementation for user resolution and attribution

users: Required<TLUserStore>;

Methods

Called when an Editor connected to this store is mounted. Can optionally return a cleanup function that will be called when unmounted.

Parameters

unknown;

Returns

(() => void) | void;

Optional cleanup function