tiptap/docs/api/marks/superscript.md
2022-11-07 21:41:00 +01:00

1.8 KiB
Raw Blame History

description icon
Write slightly above the normal line to show youre just next level. superscript

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 rendered accordingly.

::: warning Restrictions The extension will generate the corresponding <sup> HTML tags when reading contents of the Editor instance. All text in superscript, regardless of the method will be normalized to <sup> HTML tags. :::

Installation

npm install @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

https://embed.tiptap.dev/preview/Marks/Superscript