mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-24 01:17:50 +08:00
67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
---
|
||
description: Write slightly below the normal line to show you’re unique.
|
||
icon: subscript
|
||
---
|
||
|
||
# Subscript
|
||
[](https://www.npmjs.com/package/@tiptap/extension-subscript)
|
||
[](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 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
|
||
```bash
|
||
npm install @tiptap/extension-subscript
|
||
```
|
||
|
||
## Settings
|
||
|
||
### HTMLAttributes
|
||
Custom HTML attributes that should be added to the rendered HTML tag.
|
||
|
||
```js
|
||
Subscript.configure({
|
||
HTMLAttributes: {
|
||
class: 'my-custom-class',
|
||
},
|
||
})
|
||
```
|
||
|
||
## Commands
|
||
|
||
### setSubscript()
|
||
Mark text as subscript.
|
||
|
||
```js
|
||
editor.commands.setSubscript()
|
||
```
|
||
|
||
### toggleSubscript()
|
||
Toggle subscript mark.
|
||
|
||
```js
|
||
editor.commands.toggleSubscript()
|
||
```
|
||
|
||
### unsetSubscript()
|
||
Remove subscript mark.
|
||
|
||
```js
|
||
editor.commands.unsetSubscript()
|
||
```
|
||
|
||
## 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
|
||
https://embed.tiptap.dev/preview/Marks/Subscript
|