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

1.7 KiB
Raw Blame History

description icon
Write slightly below the normal line to show youre unique. subscript

Subscript

Version Downloads

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

::: warning 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. :::

Installation

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

Command Windows/Linux macOS
toggleSubscript() Control , Cmd ,

Source code

packages/extension-subscript/

Usage

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