mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-06-27 06:50:42 +08:00
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
# Superscript
|
||
[](https://www.npmjs.com/package/@tiptap/extension-superscript)
|
||
[](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
|
||
| Command | Parameters | Description |
|
||
| ----------------- | ---------- | ------------------------- |
|
||
| setSuperscript | — | Mark text as superscript. |
|
||
| toggleSuperscript | — | Toggle superscript mark. |
|
||
| unsetSuperscript | — | Remove superscript mark. |
|
||
|
||
## Keyboard shortcuts
|
||
* Windows/Linux: `Control` `.`
|
||
* macOS: `Cmd` `.`
|
||
|
||
## Source code
|
||
[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Marks/Superscript"></tiptap-demo>
|