method

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. Call discard when abandoning a draft; closing the field also cleans it up.

Arguments

Argument	Type	Description
`scope`	`EmbeddedSchemaFormScope \| EmbeddedSchemaVariantScope`	The scope value.

Returns

The declared result.

EmbeddedSchemaDraft

Full signature

FieldAuthoringHost.beginSchemaDraft(
	scope: EmbeddedSchemaFormScope | EmbeddedSchemaVariantScope,
): EmbeddedSchemaDraft

Source packages/plugin/src/authoring.ts:168

Related types

EmbeddedSchemaFormScope
Select an existing group of ordinary fields inside a plugin value, such as the fields of one rich-text card. Go must declare the embedded tree and its schemas. Ridu locates the data by its stable identity, even when the card moves.
EmbeddedSchemaVariantScope
Select a Go-declared embedded variant when creating or copying an item's field data.
EmbeddedSchemaDraft
A temporary Apply/Cancel form for fields inside one plugin item. Its edits stay separate from the document until your Apply handler accepts them. This is not a saved document draft/version and cannot save to the server itself. Ridu tracks pending edits so the outer form can ask the user to Apply or Cancel.