DEVELOPER REFERENCE · v4.0.0

HtmlEditor API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

HtmlEditor8 props2 callbacks0 methods

HtmlEditor props
Name	Type	Description
`formatSource`Optional	`((html: string) => string) \| undefined`Inspect type	Override formatRichTextHtml for source presentation on entry, never while typing.
`value`Required	`string`	Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
`required`Optional	`boolean \| undefined`	Requires a non-empty value or selection before the edit can be accepted.
`maxLength`Optional	`number \| undefined`	Maximum accepted text length for the editor value.
`text`Optional	`Partial<HtmlEditorText> \| undefined`Inspect type	Display text or localized text overrides; expand the type when this prop accepts an object.
`actions`Optional	`Partial<EditorActionText> \| undefined`Inspect type	Actions rendered by this component, or action-label overrides for editor fields; expand the declared type.
`autoApply`Optional	`boolean \| undefined`	Apply completed edits automatically. Set false to require explicit Apply.
`showActions`Optional	`boolean \| undefined`	Show Apply/Cancel buttons. Defaults to true only when autoApply is false.

HtmlEditor events and callbacks
Name	Type	Description
`onApply`Required	`(value: string) => void`Inspect type	Commits the proposed edit. The application owns applying the emitted value or change.
`onCancel`Required	`() => void`Inspect type	Cancels the current edit or proposed change without applying it.

No component-specific imperative methods. Use props and callbacks to control this component.