EditorAtom • tldraw Docs

Table of contents

Methods
- get
- getAtom
- set
- update

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> {}

Constructor

Constructs a new instance of the EditorAtom class

Parameters

Name	Description
`name`	`string`
`getInitialState`	`(editor: Editor) => T`

Methods

get()

get(editor: Editor): T

Parameters

Name	Description
`editor`	`Editor`

Returns

getAtom()

getAtom(editor: Editor): Atom<T>

Parameters

Name	Description
`editor`	`Editor`

Returns

Atom<T>

set()

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

Parameters

Name	Description
`editor`	`Editor`
`state`	`T`

Returns

update()

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

Parameters

Name	Description
`editor`	`Editor`
`update`	`(state: T) => T`