interface
FieldAuthoringHost
Optional services supplied to a plugin field for embedded forms, related documents, and plugin requests.
Properties
| Property | Type | Description |
|---|---|---|
schemaForm | Snippet< | Render an existing item's ordinary fields in the parent form. Pass onChange when your editor needs to record each child edit in its own history and serialization. |
schemaHeader | Snippet< | Render the block-name input and field feedback, without the card chrome. Uses the item's schema, access, visibility and stable identity. An open draft locks the card input. Hidden or unreadable names render no control. |
beginSchemaDraft | (scope: EmbeddedSchemaFormScope | | Start a temporary Apply/Cancel form. Pass { treeKey, identity } to edit an
existing item, or { treeKey, caseTag, variantSlug } to prepare a new one using
Go-declared field defaults. Creation does not insert anything into your value.
Call discard when abandoning a draft; closing the field also cleans it up. |
schemaDraftEditor | Snippet< | Render a draft in Ridu's drawer; your onApply writes the accepted data into your plugin value. |
schemaIssues | (scope: EmbeddedSchemaFormScope) => readonly ValidationIssue[] | Read current parent-form issues for an existing embedded item, for example for a card badge. |
copySchemaPayload | (scope: EmbeddedSchemaVariantScope, | Copy an item's ordinary field data and give its schema-declared nested rows/items fresh IDs. Use when duplicating to avoid sharing identities. This does not insert the copy or copy your outer plugin item; update that structure in your editor. |
createSchemaPayload | (scope: EmbeddedSchemaVariantScope) => Record< | Create Go-declared default fields and fresh identity for inline insertion; your editor inserts and serializes the result. |
collections | readonly SchemaCollection[] | The collections value. |
documentRevision | number | The documentRevision value. |
locale | string | The locale value. |
canCreateDocument | (collection: string) => boolean | Whether the current admin session may create documents in this collection. This is a presentation hint for create controls, not authorization. Access is checked again by the reference browser and operation engine when work is saved. |
referenceBrowser | Component< | The referenceBrowser value. |
findDocument | (collection: string, | The findDocument value. |
requestPlugin | < | The requestPlugin value. |
How it works
Check an optional method before using it. Embedded forms edit the unsaved parent document; your plugin editor owns insertion, history, and serialization of its outer value.
requestPlugin is owner-scoped by the framework to the component’s paired backend plugin and routes through the configured SDK transport.
Full signature
interface FieldAuthoringHost { ... }Methods
FieldAuthoringHost.findDocument()Public method FieldAuthoringHost.findDocument from @riducms/plugin.
FieldAuthoringHost.createSchemaPayload()Create a new embedded item's field payload with Go-declared defaults and a fresh identity.
FieldAuthoringHost.schemaForm()Render ordinary fields of an existing embedded item in the unsaved parent form.
FieldAuthoringHost.referenceBrowser()Public method FieldAuthoringHost.referenceBrowser from @riducms/plugin.
FieldAuthoringHost.requestPlugin()Public method FieldAuthoringHost.requestPlugin from @riducms/plugin.
FieldAuthoringHost.beginSchemaDraft()Start a temporary Apply/Cancel form. Pass
{ treeKey, identity }to edit an existing item, or{ treeKey, caseTag, variantSlug }to prepare a new one using Go-declared field defaults. Creation does not insert anything into your value. Calldiscardwhen abandoning a draft; closing the field also cleans it up.FieldAuthoringHost.canCreateDocument()Whether the current admin session may create documents in this collection. This is a presentation hint for create controls, not authorization. Access is checked again by the reference browser and operation engine when work is saved.
FieldAuthoringHost.copySchemaPayload()Copy an item's ordinary field data and give its schema-declared nested rows/items fresh IDs. Use when duplicating to avoid sharing identities. This does not insert the copy or copy your outer plugin item; update that structure in your editor.
FieldAuthoringHost.schemaDraftEditor()Render a draft in Ridu's drawer; your
onApplywrites the accepted data into your plugin value.FieldAuthoringHost.schemaHeader()Render the block-name input and field feedback, without the card chrome. Uses the item's schema, access, visibility and stable identity. An open draft locks the card input. Hidden or unreadable names render no control.
FieldAuthoringHost.schemaIssues()Read current parent-form issues for an existing embedded item, for example for a card badge.