4f:I[314491,["/_next/static/immutable/chunks/3arlv5bvukoo2.js","/_next/static/immutable/chunks/39v64hmfyo-sr.js","/_next/static/immutable/chunks/2nvof3-29tvc3.js","/_next/static/immutable/chunks/3tjobt77z_9dj.js","/_next/static/immutable/chunks/04j_o97cgxn2x.js","/_next/static/immutable/chunks/3upr08c9vtj8w.js","/_next/static/immutable/chunks/1ww0328si-u8x.js","/_next/static/immutable/chunks/11mfl5ymqld9-.js","/_next/static/immutable/chunks/2xxcqy6ppds3l.js","/_next/static/immutable/chunks/3j06ow7w40nxu.js","/_next/static/immutable/chunks/31nn7jwsjvqii.js","/_next/static/immutable/chunks/43_s7jweyypoh.js","/_next/static/immutable/chunks/0p6vao205o1jc.js","/_next/static/immutable/chunks/1_kyvgkyokw92.js","/_next/static/immutable/chunks/1lo-zn37dolb5.js","/_next/static/immutable/chunks/1v8k6yxw1rg0u.js"],"FilesView"] 50:T14ca,--- title: Exit Break --- ## Features - Exit from nested block structures (like code blocks, tables, columns) using keyboard shortcuts. - Automatically determines the appropriate exit point based on block hierarchy. ## Kit Usage ### Installation The fastest way to add exit break functionality is with the `ExitBreakKit`, which includes pre-configured `ExitBreakPlugin` with keyboard shortcuts. ### Add Kit ```tsx import { createPlateEditor } from 'platejs/react'; import { ExitBreakKit } from '@/components/editor/plugins/exit-break-kit'; const editor = createPlateEditor({ plugins: [ // ...otherPlugins, ...ExitBreakKit, ], }); ``` ## Manual Usage ### Add Plugin ```tsx import { ExitBreakPlugin } from 'platejs'; import { createPlateEditor } from 'platejs/react'; const editor = createPlateEditor({ plugins: [ // ...otherPlugins, ExitBreakPlugin, ], }); ``` ### Configure Plugin ```tsx import { ExitBreakPlugin } from 'platejs'; import { createPlateEditor } from 'platejs/react'; const editor = createPlateEditor({ plugins: [ // ...otherPlugins, ExitBreakPlugin.configure({ shortcuts: { insert: { keys: 'mod+enter' }, insertBefore: { keys: 'mod+shift+enter' }, }, }), ], }); ``` - `shortcuts.insert`: Defines a keyboard [shortcut](/docs/plugin-shortcuts) to exit and insert block after. - `shortcuts.insertBefore`: Defines a keyboard [shortcut](/docs/plugin-shortcuts) to exit and insert block before. ## Keyboard Shortcuts Exit the current block structure and insert a new block after. Exit the current block structure and insert a new block before. ## Plugins ### `ExitBreakPlugin` Provides transforms to exit nested block structures automatically. The plugin determines the appropriate exit point by finding the first ancestor that allows standard block siblings. Keyboard shortcuts configuration. Shortcut to exit and insert block after. - **Example:** `{ keys: 'mod+enter' }` Shortcut to exit and insert block before. - **Example:** `{ keys: 'mod+shift+enter' }` ## How Exit Break Works Exit break uses the [`isStrictSiblings`](/docs/api/core/plate-plugin#isstrictsiblings) property to determine where to insert new blocks when exiting nested structures. ### Exit Point Determination When you trigger exit break: 1. Starts from the current text block (e.g., paragraph inside a table cell) 2. Traverses up the document tree looking at each ancestor 3. Finds the first ancestor with `isStrictSiblings: false` 4. Inserts a new paragraph as a sibling to that ancestor ### Examples **Code Block:** ```tsx // ← Exit point (top-level block) code| // ← Starting position

// ← New paragraph inserted here ``` **Table in Column (exits at table level):** ```tsx // First exit // ← Exit point (isStrictSiblings: false) // isStrictSiblings: true

// isStrictSiblings: true

content|

// ← Starting position

// ← New paragraph inserted here // Second exit // ← Exit point (isStrictSiblings: false) // isStrictSiblings: true

content

// ← Starting position

// ← New paragraph inserted here ``` ### Custom Plugin Configuration Configure [`isStrictSiblings`](/docs/api/core/plate-plugin#isstrictsiblings) for custom plugins: ```tsx // Table structure const CustomTablePlugin = createSlatePlugin({ key: 'table', node: { isElement: true, // isStrictSiblings: false (default) - allows paragraph siblings }, }); const CustomTableRowPlugin = createSlatePlugin({ key: 'tr', node: { isElement: true, isStrictSiblings: true, // Only allows tr siblings }, }); const CustomTableCellPlugin = createSlatePlugin({ key: 'td', node: { isElement: true, isStrictSiblings: true, // Only allows td/th siblings }, }); 4e:["$","div",null,{"className":"mt-3 flex min-h-0 min-w-0 flex-1 flex-col gap-3","children":[null,["$","$L4f",null,{"files":[{"path":"../../content/docs/(plugins)/(functionality)/(utils)/exit-break.mdx","content":"$50","type":"registry:file","target":"content/docs/plate/(plugins)/(functionality)/(utils)/exit-break.mdx"}],"className":"h-[70svh] min-h-80"}]]}]