Docs
Exit Break

Exit Break

Exit a large block using a shortcut.

Exit Break ⏎

Configure how exit breaks (line breaks between blocks) behave using simple rules:
hotkey – Use hotkeys like ⌘⏎ to move the cursor to the next block
query – Specify block types where exit breaks are allowed.
before – Choose whether the cursor exits to the next or previous block
Try here ⌘⏎
And in the middle ⌘⏎ of a block.
Exit breaks also work within nested blocks:
Plugin
Element
Inline
Void
Heading


No
Image
Yes
No
Yes
Mention
Yes
Yes
Yes


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,
        },
      ],
    },
  }),
];

Keyboard Interactions

KeyDescription
Cmd + Enter

Start a new block after the selected block.

Cmd + Shift + Enter

Start a new block before the selected block.

API

createExitBreakPlugin

Options

Collapse all

    An array of rule objects each containing the following properties:

exitBreak

Exit a large block using a shortcut.

Parameters

Collapse all

    The editor instance.

    The options for the exit break operation.

Returns

Collapse all

    Indicates whether the exit break was successful.

exitBreakAtEdges

Checks if the selection is at the edge of its parent block and performs an "exit break" operation if specified.

Parameters

Collapse all

    The editor instance.

Returns

Collapse all

    Indicates whether the edge of the selection was queried.

    Indicates whether the selection is at the edge of its parent block.

    Indicates whether the selection is at the start of its parent block.

ExcalidrawFont