Vizel API / react/src / UseVizelEditorStateOptions

Interface: UseVizelEditorStateOptions<T>

Defined in: packages/react/src/_reactivity.ts:171

Options accepted by useVizelEditorState.

Type Parameters

Type Parameter
T

Properties

editor?

readonly optional editor?: Editor | null;

Defined in: packages/react/src/_reactivity.ts:186

Editor instance to subscribe to. Defaults to the editor resolved from the surrounding VizelProvider. A component that already receives the editor as a prop passes it here so the selector subscribes to that exact instance even when no provider wraps the component (for example, a standalone <VizelToolbar editor={...} />).

---

equalityFn?

readonly optional equalityFn?: (a, b) => boolean;

Defined in: packages/react/src/_reactivity.ts:178

Equality predicate the hook applies to consecutive selector results. Object.is is the default; the bundled shallowEqualArray and shallowEqualObject cover the shapes that selectors typically return.

Parameters

Parameter	Type
a	T
b	T

Returns

boolean