GlobalEditViewProps
Defined in: packages/core/src/framework.ts:189
Props passed to the GlobalEditView component.
TGlobalSlug narrows to a literal when the caller supplies one — see the
note on CollectionListViewProps.
Type Parameters
Section titled “Type Parameters”TGlobalSlug
Section titled “TGlobalSlug”TGlobalSlug extends GlobalSlug = GlobalSlug
TDocument
Section titled “TDocument”TDocument extends VexDocumentGlobal = VexDocumentGlobal
Properties
Section titled “Properties”global
Section titled “global”global:
TGlobalSlug
Defined in: packages/core/src/framework.ts:194
The slug of the global whose fields will be rendered, resolved from useVexConfig().
initialData?
Section titled “initialData?”
optionalinitialData?:TDocument|null
Defined in: packages/core/src/framework.ts:199
Pre-fetched document from the server for SSR hydration.
null explicitly means “no document found”. undefined means “not loaded yet”.
initialPreviewPanelOpen?
Section titled “initialPreviewPanelOpen?”
optionalinitialPreviewPanelOpen?:boolean
Defined in: packages/core/src/framework.ts:205
The live-preview panel’s initial open state, read server-side (Decision 51) from the
shared vex-admin cookie’s livePreview.panelOpen field (or the global’s
admin.livePreview.defaultOpen when no cookie exists) by NextAdminPage.
initialPreviewPanelSize?
Section titled “initialPreviewPanelSize?”
optionalinitialPreviewPanelSize?:number
Defined in: packages/core/src/framework.ts:212
The live-preview split’s handle position — the form column’s percentage of
the pane — read server-side (Decision 51) from the shared vex-admin
cookie’s livePreview.panelSize field by NextAdminPage, so a remembered width
renders on the first paint instead of snapping into place after hydration.
initialPreviewUrl?
Section titled “initialPreviewUrl?”
optionalinitialPreviewUrl?:string
Defined in: packages/core/src/framework.ts:217
The preview URL resolved server-side for a { server } resolver, so the
iframe’s first paint needs no Convex round trip.