method
FieldAuthoringHost.schemaForm
Render ordinary fields of an existing embedded item in the unsaved parent form.
Arguments
| Argument | Type | Description |
|---|---|---|
args | [EmbeddedSchemaFormProps] | The embedded tree key and stable item identity, with optional read-only mode and onChange callback. |
Returns
Rendered Svelte fields. Use this as a snippet in your component template.
{ '{@render ...} must be called with a Snippet': "import type { Snippet } from 'svelte'"; } & unique symbolHow it works
Render with {@render authoring.schemaForm({ treeKey, identity, onChange })}. Child edits update the unsaved parent form. Pass onChange when your editor also needs to record them in its own history and serialized plugin value.
Use beginSchemaDraft and schemaDraftEditor when the item needs Apply/Cancel. The parent document is saved later through its ordinary Save action.
Full signature
FieldAuthoringHost.schemaForm(
this: void,
args_0: EmbeddedSchemaFormProps,
): {
"{
@render ...
} must be called with a Snippet": "import type { Snippet } from 'svelte'"
} & typeof SnippetReturnRelated types
EmbeddedSchemaFormPropsProps for rendering the ordinary fields of an existing embedded item inside the parent document form.