tiptap/docs/api/marks/subscript.md

38 lines
1.7 KiB
Markdown
Raw Normal View History

# Subscript
[![Version](https://img.shields.io/npm/v/@tiptap/extension-subscript.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-subscript)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-subscript.svg)](https://npmcharts.com/compare/@tiptap/extension-subscript?minimal=true)
Use this extension to render text in <sub>subscript</sub>. 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
```bash
# with npm
npm install @tiptap/extension-subscript
# with Yarn
yarn add @tiptap/extension-subscript
```
## Settings
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## Commands
| Command | Parameters | Description |
| --------------- | ---------- | ----------------------- |
| setSubscript | — | Mark text as subscript. |
| toggleSubscript | — | Toggle subscript mark. |
| unsetSubscript | — | Remove subscript mark. |
2021-06-09 17:57:54 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| ----------------- | ------------------ | -------------- |
| toggleSubscript() | `Control`&nbsp;`,` | `Cmd`&nbsp;`,` |
2021-06-09 17:57:54 +08:00
## Source code
[packages/extension-subscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/)
## Usage
<tiptap-demo name="Marks/Subscript"></tiptap-demo>