EditorAtom

An Atom that is scoped to the lifetime of an Editor.

This is useful for storing UI state for tldraw applications. Keeping state scoped to an editor instead of stored in a global atom can prevent issues with state being shared between editors when navigating between pages, or when multiple editor instances are used on the same page.

class EditorAtom<T> {}

Constructs a new instance of the EditorAtom class

Parameters

string

(editor: Editor) => T

Methods

get(editor: Editor): T

Parameters

Editor

Returns

T

getAtom(editor: Editor): Atom<T>

Parameters

Editor

Returns

Atom<T>

set(editor: Editor, state: T): T

Parameters

Editor

T

Returns

T

update(editor: Editor, update: (state: T) => T): T

Parameters

Editor

(state: T) => T

Returns

T