mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-14 18:49:02 +08:00
38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
# 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 editor’s 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. |
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| ----------------- | ------------------ | -------------- |
|
||
| toggleSubscript() | `Control` `,` | `Cmd` `,` |
|
||
|
||
## Source code
|
||
[packages/extension-subscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-subscript/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Marks/Subscript"></tiptap-demo>
|