Superscript

PreviousNext
Mark Toolbar Button
Loading...

Features

  • Format text as superscript for mathematical expressions or footnotes
  • Keyboard shortcut support for quick formatting
  • Renders as <sup> HTML element by default

Kit Usage

Installation

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

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 SuperscriptPlugin in your Plate plugins array when creating the editor.

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

Configure Plugin

You can configure the SuperscriptPlugin with custom keyboard shortcuts.

import { SuperscriptPlugin } from '@platejs/basic-nodes/react';
import { createPlateEditor } from 'platejs/react';
 
const editor = createPlateEditor({
  plugins: [
    // ...otherPlugins,
    SuperscriptPlugin.configure({
      shortcuts: { toggle: { keys: 'mod+period' } },
    }),
  ],
});
  • shortcuts.toggle: Defines a keyboard shortcut to toggle superscript formatting.

Add Toolbar Button

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

Plugins

SuperscriptPlugin

Plugin for superscript text formatting. Renders as <sup> HTML element by default.

Transforms

tf.superscript.toggle

Toggles the superscript formatting for the selected text.

上标Underline