2021-06-01 22:18:25 +08:00
# 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 editor’ s 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
| Option | Type | Default | Description |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
## 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-01 22:18:25 +08:00
2021-06-09 17:57:54 +08:00
## Keyboard shortcuts
2021-10-02 05:04:47 +08:00
| Command | Windows/Linux | macOS |
| ------------------- | ------------------ | -------------- |
| toggleSuperscript() | `Control` `.` | `Cmd` `.` |
2021-06-09 17:57:54 +08:00
2021-06-01 22:18:25 +08:00
## Source code
[packages/extension-superscript/ ](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/ )
## Usage
2021-08-26 05:10:20 +08:00
< tiptap-demo name = "Marks/Superscript" > < / tiptap-demo >