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:T1081,--- title: Slash Command docs: - route: https://pro.platejs.org/docs/examples/slash-command title: Plus - route: /docs/combobox title: Combobox - route: /docs/components/slash-node title: Slash Nodes --- ## Features - Quick access to various editor commands - Triggered by `/` character - Keyboard navigation and filtering - Customizable command groups and options ## Kit Usage ### Installation The fastest way to add slash command functionality is with the `SlashKit`, which includes pre-configured `SlashPlugin` and `SlashInputPlugin` along with their [Plate UI](/docs/installation/plate-ui) components. - [`SlashInputElement`](/docs/components/slash-node): Renders the slash command combobox with predefined options ### Add Kit ```tsx import { createPlateEditor } from 'platejs/react'; import { SlashKit } from '@/components/editor/plugins/slash-kit'; const editor = createPlateEditor({ plugins: [ // ...otherPlugins, ...SlashKit, ], }); ``` ## Manual Usage ### Installation ```bash npm install @platejs/slash-command ``` ### Add Plugins ```tsx import { SlashPlugin, SlashInputPlugin } from '@platejs/slash-command/react'; import { createPlateEditor } from 'platejs/react'; const editor = createPlateEditor({ plugins: [ // ...otherPlugins, SlashPlugin, SlashInputPlugin, ], }); ``` ### Configure Plugins ```tsx import { SlashPlugin, SlashInputPlugin } from '@platejs/slash-command/react'; import { createPlateEditor } from 'platejs/react'; import { SlashInputElement } from '@/components/ui/slash-node'; import { KEYS } from 'platejs'; const editor = createPlateEditor({ plugins: [ // ...otherPlugins, SlashPlugin.configure({ options: { trigger: '/', triggerPreviousCharPattern: /^\s?$/, triggerQuery: (editor) => !editor.api.some({ match: { type: editor.getType(KEYS.codeBlock) }, }), }, }), SlashInputPlugin.withComponent(SlashInputElement), ], }); ``` - `options.trigger`: Character that triggers the slash command combobox (default: `/`) - `options.triggerPreviousCharPattern`: RegExp pattern for character before trigger - `options.triggerQuery`: Function to determine when slash commands should be enabled - `withComponent`: Assigns the UI component for the slash command interface ## Usage How to use slash commands: 1. Type `/` anywhere in your document to open the slash menu 2. Start typing to filter options or use arrow keys to navigate 3. Press Enter or click to select an option 4. Press Escape to close the menu without selecting Available options include: - Text blocks (paragraphs, headings) - Lists (bulleted, numbered, to-do) - Advanced blocks (tables, code blocks, callouts) - Inline elements (dates, equations) Use keywords to quickly find options. For example, type '/ul' for Bulleted List or '/h1' for Heading 1. ## Plate Plus ## Plugins ### SlashPlugin Plugin for slash command functionality. Extends [TriggerComboboxPluginOptions](/docs/combobox#triggercomboboxpluginoptions). Character that triggers slash command combobox. - **Default:** `'/'` RegExp to match character before trigger. - **Default:** `/^\s?$/` Function to create combobox input element. - **Default:** ```tsx () => ({ children: [{ text: '' }], type: KEYS.slashInput, }); ``` Function to determine when slash commands should be enabled. Useful for disabling in certain contexts like code blocks. ### SlashInputPlugin Handles the input behavior for slash command insertion. 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)/(combobox)/slash-command.mdx","content":"$50","type":"registry:file","target":"content/docs/plate/(plugins)/(functionality)/(combobox)/slash-command.mdx"}],"className":"h-[70svh] min-h-80"}]]}]