tiptap/docs/api/marks/superscript.md

62 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Superscript
[![Version](https://img.shields.io/npm/v/@tiptap/extension-superscript.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-superscript)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-superscript.svg)](https://npmcharts.com/compare/@tiptap/extension-superscript?minimal=true)
Use this extension to render text in <sup>superscript</sup>. If you pass `<sup>` or text with `vertical-align: super` as inline style in the editors initial content, both will be normalized to a `<sup>` HTML tag.
## Installation
```bash
# with npm
npm install @tiptap/extension-superscript
# with Yarn
yarn add @tiptap/extension-superscript
```
## Settings
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Superscript.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
## Commands
### setSuperscript()
Mark text as superscript.
```js
editor.commands.setSuperscript()
```
### toggleSuperscript()
Toggle superscript mark.
```js
editor.commands.toggleSuperscript()
```
### unsetSuperscript()
Remove superscript mark.
```js
editor.commands.unsetSuperscript()
```
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| ------------------- | ------------------ | -------------- |
| toggleSuperscript() | `Control`&nbsp;`.` | `Cmd`&nbsp;`.` |
## Source code
[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
## Usage
<tiptap-demo name="Marks/Superscript"></tiptap-demo>