Subscript extension

VersionDownloads

Use this extension to render text in subscript. If you pass <sub> or text with vertical-align: sub as inline style in the editor’s initial content, both will be rendered accordingly.

Restrictions

The extension will generate the corresponding <sub> HTML tags when reading contents of the Editor instance. All text in subscript, regardless of the method will be normalized to <sub> HTML tags.

Install

npm install @tiptap/extension-subscript

Settings

HTMLAttributes

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

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

Commands

setSubscript()

Mark text as subscript.

editor.commands.setSubscript()

toggleSubscript()

Toggle subscript mark.

editor.commands.toggleSubscript()

unsetSubscript()

Remove subscript mark.

editor.commands.unsetSubscript()

Keyboard shortcuts

CommandWindows/LinuxmacOS
toggleSubscript()Control + ,Cmd + ,

Source code

packages/extension-subscript/