tiptap/docs/api/marks/subscript.md
2021-10-14 10:46:09 +02:00

1.6 KiB
Raw Blame History

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

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 normalized to a <sub> HTML tag.

Installation

# with npm
npm install @tiptap/extension-subscript

# with Yarn
yarn add @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