DocumentEditRuntimeState

Defined in: packages/react/src/documents/DocumentEditRuntimeContext.tsx:13

View-local UI state useVexDocument deliberately excludes (S5, decision 18): which history version is being previewed, how to re-point the view at a new row id after a mutation returns one, how to settle the form once a save round-trips, and the live-preview panel’s open state. One instance per mounted edit view — CollectionEditForm/GlobalEditView own the real state and pass it down as value; built-ins only ever read it.

Properties

livePreview?

optional livePreview?: object

Defined in: packages/react/src/documents/DocumentEditRuntimeContext.tsx:27

Live-preview panel state for this resource, or undefined when no livePreview config resolves.

isOpen

isOpen: boolean

isSplit

isSplit: boolean

toggle

toggle: () => void

Returns

void

---

onDocumentIdChange?

optional onDocumentIdChange?: (id) => void

Defined in: packages/react/src/documents/DocumentEditRuntimeContext.tsx:23

Re-points the view at a different row id — called after saveDraft/publish returns one (the first draft save on a published document bootstraps a new row). Omitted for a global, which has no separate row id to re-point.

Parameters

id

string

Returns

void

---

onSaved

onSaved: (changes) => void

Defined in: packages/react/src/documents/DocumentEditRuntimeContext.tsx:25

Defers the form’s post-save reset until the live row reflects the write — see useResetWhenSaved.

Parameters

changes

Record<string, unknown>

Returns

void

---

onViewVersion

onViewVersion: (view) => void

Defined in: packages/react/src/documents/DocumentEditRuntimeContext.tsx:17

Shows a version’s snapshot in the form, or null to return to the live document. Never saves.

Parameters

view

ViewedVersion | null

Returns

void

---

viewedVersion

viewedVersion: ViewedVersion | null

Defined in: packages/react/src/documents/DocumentEditRuntimeContext.tsx:15

The history version currently shown in the form, or null for the live document.