Select

Customize selection and deletion behavior for specific node types.

Features

  • Set a list of element types to remove on backspace
  • Set a list of element types to select on backspace, instead of removing

Installation

npm install @udecode/plate-select

Usage

import { DeletePlugin, SelectOnBackspacePlugin } from '@udecode/plate-select';
const plugins = [
  // ...otherPlugins,
  SelectOnBackspacePlugin.configure({
    options: {
      query: {
        allow: ['img', 'hr'],
      },
    },
  }),
  DeletePlugin,
];

Plugins

DeletePlugin

Plugin that removes empty blocks when pressing delete (forward delete) if they match the query options.

Options

Collapse all

    Query options to filter which empty blocks can be removed.

    • Default: { allow: ['p'] }

For example:

const plugins = [
  DeletePlugin.configure({
    options: {
      // Only remove empty paragraphs and blockquotes
      query: {
        allow: ['p', 'blockquote'],
      },
    },
  }),
];

The plugin will:

  1. Check if the current block is empty and matches the query options
  2. If true: Remove the entire block
  3. If false: Use default delete behavior
// Empty paragraph followed by code block
<editor>
  <p>
    <cursor />
  </p>
  <codeblock>
    <codeline>test</codeline>
  </codeblock>
</editor>
 
// Pressing delete will remove the empty paragraph instead of nothing
<editor>
  <codeblock>
    <codeline>test</codeline>
  </codeblock>
</editor>

SelectOnBackspacePlugin

Plugin that selects nodes instead of deleting them when pressing backspace. Useful for nodes like images or horizontal rules.

Options

Collapse all

    Query options to determine which nodes trigger selection on backspace.

    Whether to remove the node if it's empty when backspacing.

    • Default: false

For example:

const plugins = [
  SelectOnBackspacePlugin.configure({
    options: {
      // Select these nodes instead of deleting them
      query: {
        allow: ['img', 'hr'],
      },
      // Remove current node if empty
      removeNodeIfEmpty: true,
    },
  }),
];

The plugin will:

  1. When backspace is pressed at the start of a block:
  2. Check if the previous node matches query options
  3. If true:
    • Select the previous node instead of deleting it
    • Optionally remove current node if it's empty
  4. If false: Use default backspace behavior
// Empty paragraph after an image
<editor>
  <img src="..." />
  <p>
    <cursor />
  </p>
</editor>
 
// Pressing backspace will select the image instead of deleting it
<editor>
  <img src="..." selected />
  <p></p>
</editor>
 
// If removeNodeIfEmpty is true, the empty paragraph is also removed
<editor>
  <img src="..." selected />
</editor>
Reset NodeSerializing CSV