Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/@riducms/plugin
MEmbeddedSchemaDraftEditorProps.onApply

Go packages

riducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder

TypeScript packages

@riducms/sdk@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
All@riducms/pluginriducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sdk@riducms/protocol@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 168FieldDocumentForm.issuesForEmbeddedSchemaDraft.discardEmbeddedSchemaDraft.payloadEmbeddedSchemaDraft.validateEmbeddedSchemaDraftEditorProps.onApplyEmbeddedSchemaDraftEditorProps.onCancelFieldAuthoringHost.beginSchemaDraftFieldAuthoringHost.copySchemaPayload

method

EmbeddedSchemaDraftEditorProps.onApply

Receives checked field data when Apply succeeds. Insert or update the item in your plugin value and call field.set (or serialize your editor's updated state). Close your drawer UI here. Ridu discards the temporary draft after this handler returns; it does not insert data into your plugin value or save the document.

ArgumentsReturnsFull signature

Arguments

ArgumentTypeDescription
payloadRecord<string, unknown>The payload value.

Returns

The declared result.

void

Full signature

EmbeddedSchemaDraftEditorProps.onApply(payload: Record<string, unknown>): void

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