Plate

Docs

Plate Editor

API reference for Plate editor.

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

Core Properties

Parameters

Collapse all

A unique identifier for the editor.

A key that can be used to uniquely identify the editor.

The current keyboard event being processed by the editor, or null if no event is being processed.

Whether the editor is a fallback editor.

Default: false

The previous selection range in the editor.

An array of plugins that are currently being used by the editor.

A record of plugins indexed by their keys.

API Methods

Parameters

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.

Option Methods

Parameters

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.

React Hooks

Parameters

Collapse all

Subscribe to a specific option value in a React component.

Subscribe to plugin options or a derived value from options in a React component.

Plate Store Methods

Parameters

Collapse all

Update the global Plate state.

Core Plugin APIs

DebugPlugin

Parameters

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.

SlateNextPlugin

Parameters

Collapse all

Toggle a block element.

Toggle a mark on the selected text.

HtmlPlugin

Parameters

Collapse all

Deserialize HTML content into Slate nodes.

ReactPlugin

Parameters

Collapse all

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

PlateApiPlugin

Parameters

Collapse all

Redecorate the editor. This method should be overridden for proper functionality.

Parameters

Collapse all

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

PlateController PlatePlugin

Plate Editor

Core Properties

Parameters

id any

id any

key any

key any

currentKeyboardEvent KeyboardEventLike | null

currentKeyboardEvent KeyboardEventLike | null

isFallback boolean

isFallback boolean

prevSelection TRange | null

prevSelection TRange | null

pluginList AnyEditorPlatePlugin[]

pluginList AnyEditorPlatePlugin[]

plugins Record<string, AnyEditorPlatePlugin>

plugins Record<string, AnyEditorPlatePlugin>

API Methods

Parameters

getApi <C extends AnyPluginConfig = PluginConfig>(plugin?: WithRequiredKey<C>) => InferApi<C>

getApi <C extends AnyPluginConfig = PluginConfig>(plugin?: WithRequiredKey<C>) => InferApi<C>

getTransforms <C extends AnyPluginConfig = PluginConfig>(plugin?: WithRequiredKey<C>) => InferTransforms<C>

getTransforms <C extends AnyPluginConfig = PluginConfig>(plugin?: WithRequiredKey<C>) => InferTransforms<C>

getPlugin <C extends AnyPluginConfig = PluginConfig>(plugin: WithRequiredKey<C>) => C extends { node: any } ? C : EditorPlatePlugin<C>

getPlugin <C extends AnyPluginConfig = PluginConfig>(plugin: WithRequiredKey<C>) => C extends { node: any } ? C : EditorPlatePlugin<C>

getType (plugin: WithRequiredKey) => string

getType (plugin: WithRequiredKey) => string

Option Methods

Parameters

getOption <C extends AnyPluginConfig, K extends keyof InferOptions<C>, F extends InferOptions<C>[K]>(plugin: WithRequiredKey<C>, optionKey: K, ...args: F extends (...args: infer A) => any ? A : never) => F extends (...args: any[]) => infer R ? R : F

getOption <C extends AnyPluginConfig, K extends keyof InferOptions<C>, F extends InferOptions<C>[K]>(plugin: WithRequiredKey<C>, optionKey: K, ...args: F extends (...args: infer A) => any ? A : never) => F extends (...args: any[]) => infer R ? R : F

getOptions <C extends AnyPluginConfig = PluginConfig>(plugin: WithRequiredKey<C>) => InferOptions<C>

getOptions <C extends AnyPluginConfig = PluginConfig>(plugin: WithRequiredKey<C>) => InferOptions<C>

setOption <C extends AnyPluginConfig, K extends keyof InferOptions<C>>(plugin: WithRequiredKey<C>, optionKey: K, value: InferOptions<C>[K]) => void

setOption <C extends AnyPluginConfig, K extends keyof InferOptions<C>>(plugin: WithRequiredKey<C>, optionKey: K, value: InferOptions<C>[K]) => void

setOptions <C extends AnyPluginConfig>(plugin: WithRequiredKey<C>, options: Parameters<SetImmerState<InferOptions<C>>>[0] | Partial<InferOptions<C>>) => void

setOptions <C extends AnyPluginConfig>(plugin: WithRequiredKey<C>, options: Parameters<SetImmerState<InferOptions<C>>>[0] | Partial<InferOptions<C>>) => void

getOptionsStore <C extends AnyPluginConfig>(plugin: WithRequiredKey<C>) => StoreApi<C['key'], InferOptions<C>>

getOptionsStore <C extends AnyPluginConfig>(plugin: WithRequiredKey<C>) => StoreApi<C['key'], InferOptions<C>>

React Hooks

Parameters

useOption <C extends AnyPluginConfig, K extends keyof InferOptions<C>, F extends InferOptions<C>[K], Args extends Parameters<((...args: any[]) => any) & F>>(plugin: WithRequiredKey<C>, optionKey: K, ...args: Args) => F extends (...args: any[]) => any ? ReturnType<F> : F

useOption <C extends AnyPluginConfig, K extends keyof InferOptions<C>, F extends InferOptions<C>[K], Args extends Parameters<((...args: any[]) => any) & F>>(plugin: WithRequiredKey<C>, optionKey: K, ...args: Args) => F extends (...args: any[]) => any ? ReturnType<F> : F

useOptions <C extends AnyPluginConfig, U>(plugin: WithRequiredKey<C>, selector?: (s: InferOptions<C>) => U, equalityFn?: EqualityChecker<U>) => U | InferOptions<C>

useOptions <C extends AnyPluginConfig, U>(plugin: WithRequiredKey<C>, selector?: (s: InferOptions<C>) => U, equalityFn?: EqualityChecker<U>) => U | InferOptions<C>

Plate Store Methods

Parameters

setPlateState <K extends (typeof EXPOSED_STORE_KEYS)[number]>(optionKey: K, value: PlateStoreState[K]) => void

setPlateState <K extends (typeof EXPOSED_STORE_KEYS)[number]>(optionKey: K, value: PlateStoreState[K]) => void

Core Plugin APIs

DebugPlugin

Parameters

editor.api.debug.log (...args: any[]) => void

editor.api.debug.log (...args: any[]) => void

editor.api.debug.info (...args: any[]) => void

editor.api.debug.info (...args: any[]) => void

editor.api.debug.warn (...args: any[]) => void

editor.api.debug.warn (...args: any[]) => void

editor.api.debug.error (...args: any[]) => void

editor.api.debug.error (...args: any[]) => void

SlateNextPlugin

Parameters

editor.tf.toggle.block (options: ToggleBlockOptions) => void

editor.tf.toggle.block (options: ToggleBlockOptions) => void

editor.tf.toggle.mark (options: ToggleMarkOptions) => void

editor.tf.toggle.mark (options: ToggleMarkOptions) => void

HtmlPlugin

Parameters

editor.api.html.deserialize (options: { element: HTMLElement }) => TDescendant[]

editor.api.html.deserialize (options: { element: HTMLElement }) => TDescendant[]

ReactPlugin

Parameters

editor.tf.reset () => void

editor.tf.reset () => void

PlateApiPlugin

Parameters

editor.api.redecorate () => void

editor.api.redecorate () => void

Parameters

editor.tf.setValue (value: Value) => void