Plate Editor

PreviousNext

API reference for Plate editor.

A custom editor interface that extends the base Editor interface and includes additional properties and methods specific to the Plate library.

Core Properties

Attributes

Collapse all

    A unique identifier for the editor.

    An object containing the DOM state of the editor.

    A record of plugins indexed by their keys.

    An object containing editor metadata, often derived from plugins or editor configuration.

API Methods

Methods

Collapse all

    Retrieve the typed API for a plugin.

    Get the typed transforms for a plugin.

    Retrieve the editor plugin instance by its key or base plugin.

    Get the node type associated with a plugin.

    Initialize the editor value, selection, and normalization. Accepts options for auto-select, selection, normalization, value, and an onReady callback that provides context on initialization completion.

Option Methods

Methods

Collapse all

    Get a specific option value for a plugin.

    Get all options for a plugin.

    Set a specific option value for a plugin.

    Set multiple options for a plugin.

    Get the zustand-x options store for a plugin.

Core Plugin APIs

DebugPlugin

API

Collapse all

    Log a message at the 'log' level.

    Log a message at the 'info' level.

    Log a message at the 'warn' level.

    Log a message at the 'error' level.

HtmlPlugin

API

Collapse all

    Deserialize HTML content into Plate nodes.

ReactPlugin

Transforms

Collapse all

    Reset the editor state while maintaining focus if the editor was focused.

SlateReactExtensionPlugin

API

Collapse all

    Redecorate the editor.

Transforms

Collapse all

    Replace the editor value. See Controlled Value for more information.

Plate ComponentsPlate Plugin