Editor
Editor =
object
Defined in: packages/editor/src/editor.ts:38
Properties
Section titled “Properties”dom:
EditorDom
Defined in: packages/editor/src/editor.ts:39
getSnapshot()
Section titled “getSnapshot()”getSnapshot: () =>
EditorSnapshot
Defined in: packages/editor/src/editor.ts:40
Returns
Section titled “Returns”on:
ActorRef<Snapshot<unknown>,EventObject,EditorEmittedEvent>["on"]
Defined in: packages/editor/src/editor.ts:73
registerBehavior()
Section titled “registerBehavior()”registerBehavior: (
config) => () =>void
Defined in: packages/editor/src/editor.ts:44
Parameters
Section titled “Parameters”config
Section titled “config”behavior
Section titled “behavior”Behavior
Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
registerContainer()
Section titled “registerContainer()”registerContainer: (
container) => () =>void
Defined in: packages/editor/src/editor.ts:54
Register an editable container by _type, marking the array field
named in childField as editable child content. Optional of
carries nested registrations that override how immediate children of
this container render. Returns a function that unregisters the
container when called.
Parameters
Section titled “Parameters”container
Section titled “container”Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
registerLeaf()
Section titled “registerLeaf()”registerLeaf: (
leaf) => () =>void
Defined in: packages/editor/src/editor.ts:62
Register a leaf renderer for a span, inline object, or void block
object by _type. Returns a function that unregisters the leaf
when called.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
registerTextBlock()
Section titled “registerTextBlock()”registerTextBlock: (
textBlock) => () =>void
Defined in: packages/editor/src/editor.ts:71
Register a text-block renderer. There is one text-block type
per editor ('block'); registering replaces the engine’s default
text-block wrapper with consumer-provided JSX. Returns a function
that unregisters the text-block when called.
Parameters
Section titled “Parameters”textBlock
Section titled “textBlock”Returns
Section titled “Returns”():
void
Returns
Section titled “Returns”void
send()
Section titled “send()”send: (
event) =>void
Defined in: packages/editor/src/editor.ts:72
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Methods
Section titled “Methods”subscribe()
Section titled “subscribe()”subscribe(
observer):object
Defined in: packages/editor/src/editor.ts:84
Subscribe to editor state changes. The observer’s next callback fires
with the current EditorSnapshot on every relevant transition (selection
updates, content mutations, behavior dispatch, configuration changes).
The editor has no terminal state and no error path, so error and
complete are part of the observable contract but never fire. They are
kept for structural compatibility with useSyncExternalStore,
@xstate/react’s useSelector, and other observer-shaped consumers.
Parameters
Section titled “Parameters”observer
Section titled “observer”complete?
Section titled “complete?”() => void
error?
Section titled “error?”(err) => void
(snapshot) => void
Returns
Section titled “Returns”object
unsubscribe()
Section titled “unsubscribe()”unsubscribe: () =>
void
Returns
Section titled “Returns”void