Code

PreviousNext
Mark Toolbar Button
Loading...

Features

  • Format inline code snippets and technical terms
  • Keyboard shortcut support for quick formatting
  • Renders as <code> HTML element by default

Kit Usage

Installation

The fastest way to add the code plugin is with the BasicMarksKit, which includes pre-configured CodePlugin along with other basic marks and their Plate UI components.

  • CodeLeaf: Renders inline code elements.

Add Kit

Add the kit to your plugins:

import { createPlateEditor } from 'platejs/react';
import { BasicMarksKit } from '@/components/editor/plugins/basic-marks-kit';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    ...BasicMarksKit,
  ],
});

Manual Usage

Installation

pnpm add @platejs/basic-nodes

Add Plugin

Include CodePlugin in your Plate plugins array when creating the editor.

import { CodePlugin } from '@platejs/basic-nodes/react';
import { createPlateEditor } from 'platejs/react';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    CodePlugin,
  ],
});

Configure Plugin

You can configure the CodePlugin with a custom component and keyboard shortcuts.

import { CodePlugin } from '@platejs/basic-nodes/react';
import { createPlateEditor } from 'platejs/react';
import { CodeLeaf } from '@/components/ui/code-node';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    CodePlugin.configure({
      node: { component: CodeLeaf },
      shortcuts: { toggle: { keys: 'mod+e' } },
    }),
  ],
});
  • node.component: Assigns CodeLeaf to render inline code elements.
  • shortcuts.toggle: Defines a keyboard shortcut to toggle code formatting.

Add Toolbar Button

You can add MarkToolbarButton to your Toolbar to toggle code formatting.

Plugins

CodePlugin

Plugin for inline code text formatting. Renders as <code> HTML element by default.

Transforms

tf.code.toggle

Toggles the code formatting for the selected text.

代码格式高亮标记