Docs
Exit Break

Exit Break

Exit a large block using a shortcut.

Loading...

Features

  • Exit large text blocks with a single hotkey.

Installation

npm install @udecode/plate-break

Usage

import { createExitBreakPlugin } from '@udecode/plate-break';
 
const plugins = [
  // ...otherPlugins,
  createExitBreakPlugin({
    options: {
      rules: [
        {
          hotkey: 'mod+enter',
        },
        {
          hotkey: 'mod+shift+enter',
          before: true,
        },
        {
          hotkey: 'enter',
          query: {
            start: true,
            end: true,
            allow: KEYS_HEADING,
          },
          relative: true,
          level: 1,
        },
      ],
    },
  }),
];

API

createExitBreakPlugin

Parameters

Collapse all

    Options.

    An array of rule objects each containing the following properties:

exitBreak

exitBreakAtEdges

Keyboard Interactions

KeyDescription
Cmd + Enter

Start a new block after the selected block.

Cmd + Shift + Enter

Start a new block before the selected block.

ExcalidrawFont