tiptap/docs/api/marks/subscript.md

67 lines
1.6 KiB
Markdown
Raw Normal View History

---
2021-10-16 04:48:57 +08:00
description: Write slightly below the normal line to show youre unique.
2021-10-15 03:20:21 +08:00
icon: subscript
---
# 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
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Subscript.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
2021-10-02 05:25:07 +08:00
### 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()
```
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
2021-10-19 00:01:47 +08:00
https://embed.tiptap.dev/preview/Marks/Subscript