API Reference

This page reflects the current runtime behavior and TypeScript types. Undocumented options are not supported.

RichHtmlEditor

new RichHtmlEditor(options)

Constructor options

{
  iframe: HTMLIFrameElement | Window | string;
  maxStackSize?: number;
}

The editor uses a click-to-edit candidate model by default.

editor.init()

editor.init();

Initializes editing inside the iframe. Must be called after the iframe has loaded.

editor.getHTML()

const html = editor.getHTML();

Returns sanitized HTML with all editor-specific artifacts removed.

Internally, editor.getHTML() forwards to the lower-level getCleanHTML() function exposed by the functional API.