Plate Core

API

createPlugins

Creates a new array of plugins by overriding the plugins in the original array.

Parameters

Collapse all

plugins optional PlatePlugin[]

The original array of plugins.

options optional object

The options to override plugins.

Show child attributes

Returns

An array of plugins with overridden components or attributes.

createAtomStore

Creates an atom store from an initial value. Each property of the initial value will have a getter and setter.

Parameters

Collapse all

initialState T

The initial state of the atom store.

options CreateAtomStoreOptions

An optional object which can contain a scope, an initial store, and a name.

Returns

An AtomStoreApi object.

createPlateEditor

Generates a new instance of a PlateEditor, initialized with a set of plugins and their configurations.

Parameters

Collapse all

editor optional TEditor<V>

Initial editor without withPlate.

plugins optional PlatePlugin[]

An array of editor plugins.

components optional Record<string, PlatePluginComponent>

Components to inject into plugins.

overrideByKey optional OverrideByKey<V>

Plugins to override by key.

normalizeInitialValue optional boolean

A flag indicating whether to normalize the initial editor value.

withPlateOptions optional WithPlateOptions<V, E & PlateEditor<V>>

Options for the withPlate function, excluding plugins.

Returns

An instance of PlateEditor with the specified plugins, components, and settings applied.

createPluginFactory

Generates a factory for creating plugins with a default plugin, which can be overridden.

Parameters

Collapse all

defaultPlugin PlatePlugin

The default plugin. The only required property is key.

override optional Partial<PlatePlugin>

Overrides for the default plugin.

overrideByKey optional OverrideByKey

Overrides for nested plugins (in plugin.plugins) by key.

Returns

A plugin factory based on the default one, with the specified overrides applied.

getPlugin

Retrieves a plugin by plugin key.

Parameters

Collapse all

editor PlateEditor

The editor to extract the plugin from.

key PluginKey

The key of the plugin to retrieve.

Returns

Returns the requested plugin. If the plugin does not exist, returns an object with only the key.

getPluginInjectProps

Retrieves the props to be injected by a plugin, identified by its key.

Parameters

Collapse all

editor PlateEditor

The editor to extract the plugin from.

key PluginKey

The key of the plugin whose inject props to retrieve.

Returns

Returns the props to be injected by the specified plugin. If the plugin does not exist or does not have inject props, returns an empty object.

getPluginOptions

Retrieves the options of a plugin, identified by its key.

Parameters

Collapse all

editor PlateEditor

The editor to extract the plugin from.

key PluginKey

The key of the plugin whose options to retrieve.

Returns

Returns the options of the specified plugin. If the plugin does not exist or does not have options, returns an empty object.

getPluginType

Retrieves the type of a plugin, identified by its key.

Parameters

Collapse all

editor PlateEditor

The editor to extract the plugin from.

key string

The key of the plugin whose type to retrieve.

Returns

Returns the type of the specified plugin. If the plugin does not exist or does not have a type, returns the key.

Hotkeys

An object containing functions to check for various hotkeys. Each function takes a KeyboardEvent and returns a boolean indicating whether the hotkey was pressed.

Parameters

Expand all

isBold function

isCompose function

isMoveBackward function

isMoveForward function

isDeleteBackward function

isDeleteForward function

isDeleteLineBackward function

isDeleteLineForward function

isDeleteWordBackward function

isDeleteWordForward function

isExtendBackward function

isExtendForward function

isExtendLineBackward function

isExtendLineForward function

isItalic function

isMoveLineBackward function

isMoveLineForward function

isMoveWordBackward function

isMoveWordForward function

isRedo function

isSoftBreak function

isSplitBlock function

isTab function

isTransposeCharacter function

isUndo function

isUntab function

toggleNodeType

Toggle the type of the selected node. No operation is performed if activeType equals inactiveType.

Parameters

Collapse all

editor PlateEditor<V>

The editor.

options ToggleNodeTypeOptions

Show child attributes

editorNodesOptions optional Omit<GetNodeEntriesOptions<V>, 'match'>

Options for getting the nodes of the editor.

useElement

Hook to get the element from a node component.

Parameters

Collapse all

pluginKey optional string

The plugin key.

• Default: the closest element key.

Returns

The value of the element as a TElement.

useEditorRef

Get the Slate editor reference without re-rendering.

• Does not re-render on editor change.
• Should be used inside Plate.
• Note the reference does not change when the editor changes.

Parameters

Collapse all

id optional PlateId

The ID of the plate editor. Useful only when nesting editors. Default is using the closest editor id.

Returns

A PlateEditor object, which is the Slate editor.

useEditorSelector

Subscribe to a specific property of the editor.

• Calls the selector function on editor change.
• Re-renders when the result of the selector changes.
• Should be used inside Plate.

Parameters

Collapse all

selector (editor: PlateEditor<V>, prev?: T) => T

The selector function.

deps DependencyList

The dependency list for the selector function.

options optional UseEditorSelectorOptions<T>

Show child attributes

Returns

The return value of the selector function.

useEditorState

Get the Slate editor reference with re-rendering.

• Re-renders on editor change.
• Supports nested editors.
• Should be used inside Plate.
• Note the reference does not change when the editor changes.
• If performance is a concern, useEditorSelector should be used instead.

Parameters

Collapse all

id optional PlateId

The ID of the plate editor. Default is using the closest editor id.

Returns

A PlateEditor object, which is the Slate editor.

useEditorReadOnly

Get the editor's readOnly state.

Parameters

Collapse all

id optional PlateId

The ID of the plate editor.

Returns

The readOnly state of the editor.

useEditorSelection

Get the editor's selection. Memoized so it does not re-render if the range is the same.

Parameters

Collapse all

id optional PlateId

The ID of the plate editor.

Returns

The current selection in the editor.

useEditorVersion

Get the version of the editor value. That version is incremented on each editor change.

Parameters

Collapse all

id optional PlateId

The ID of the plate editor.

Returns

The current version of the editor value.

useSelectionVersion

Get the version of the editor selection. That version is incremented on each selection change (the range being different).

Parameters

Collapse all

id optional PlateId

The ID of the plate editor.

Returns

The current version of the editor selection.

Core plugins

createDeserializeAstPlugin

Enables support for deserializing inserted content from Slate Ast format to Slate format while applying a small bug fix.

createDeserializeHtmlPlugin

Enables support for deserializing inserted content from HTML format to Slate format.

createEditorProtocolPlugin

Reset marks when the selection is at the start of a block and after delete operations.

createEventEditorPlugin

Creates a plugin that dispatches focus and blur events.

createHistoryPlugin

Creates a plugin that enables history support for the editor.

createInlineVoidPlugin

Creates a plugin that merges and registers all the inline types and void types from the plugins and options, using editor.isInline and editor.isVoid.

createInsertDataPlugin

Creates a plugin that overrides the default insertData function in the editor, which is called when data is being pasted or dragged into the editor.

createLengthPlugin

Creates a plugin that enforces a maximum length for the editor.

createNodeFactoryPlugin

Creates a plugin that overrides the default blockFactory and childrenFactory functions in the editor. These functions are used to generate the default blocks and children for the editor.

createPrevSelectionPlugin

Creates a plugin that keeps track of the previous selection in the editor and the current keyboard event being processed.

createReactPlugin

Creates a plugin that adds withTReact to the editor, which is a generic typed version of withReact from 'slate-react' library.

withPlate

An overrider that applies the withInlineVoid and all plate plugins' withOverrides.

withTReact

Generic typed version of withReact from 'slate-react' library.