mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-12 00:19:02 +08:00
33 lines
1.5 KiB
Markdown
33 lines
1.5 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. |
|
|||
|
|
|
|||
|
|
## Source code
|
|||
|
|
[packages/extension-superscript/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-superscript/)
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
<demo name="Marks/Superscript" highlight="3-5,17,36" />
|