tiptap/docs/api/marks/superscript.md

1.5 KiB
Raw Blame History

Superscript

Version Downloads

Use this extension to render text in superscript. If you pass <sup> or text with vertical-align: super as inline style in the editors initial content, both will be normalized to a <sup> HTML tag.

Installation

# with npm
npm install @tiptap/extension-superscript

# with Yarn
yarn add @tiptap/extension-superscript

Settings

HTMLAttributes

Custom HTML attributes that should be added to the rendered HTML tag.

Superscript.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

Commands

setSuperscript()

Mark text as superscript.

editor.commands.setSuperscript()

toggleSuperscript()

Toggle superscript mark.

editor.commands.toggleSuperscript()

unsetSuperscript()

Remove superscript mark.

editor.commands.unsetSuperscript()

Keyboard shortcuts

Command Windows/Linux macOS
toggleSuperscript() Control . Cmd .

Source code

packages/extension-superscript/

Usage