tiptap/docs/api/marks/superscript.md

67 lines
1.8 KiB
Markdown
Raw Normal View History

---
2021-10-16 04:48:57 +08:00
description: Write slightly above the normal line to show youre just next level.
2021-10-15 03:20:21 +08:00
icon: superscript
---
# 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)
2022-11-08 04:41:00 +08:00
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 rendered accordingly.
::: warning Restrictions
The extension will generate the corresponding `<sup>` HTML tags when reading contents of the `Editor` instance. All text in superscript, regardless of the method will be normalized to `<sup>` HTML tags.
:::
## Installation
```bash
npm install @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
2021-10-02 05:25:07 +08:00
### 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()
```
2021-06-09 17:57:54 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| ------------------- | ------------------ | -------------- |
| toggleSuperscript() | `Control`&nbsp;`.` | `Cmd`&nbsp;`.` |
2021-06-09 17:57:54 +08:00
## Source code
[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
## Usage
2021-10-19 00:01:47 +08:00
https://embed.tiptap.dev/preview/Marks/Superscript