tiptap/docs/src/docPages/api/extensions/underline.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Underline
Use this extension to render text <u>underlined</u>. If you pass `<u>` tags, or text with inline `style` attributes setting `text-decoration: underline` in the editors initial content, they all will be rendered accordingly.
2020-09-23 18:03:03 +08:00
Be aware that underlined text in the Internet usually indicates that its a clickable link. Dont confuse your users with underlined text.
::: warning Restrictions
The extension will generate the corresponding `<u>` HTML tags when reading contents of the `Editor` instance. All text marked underlined, regardless of the method will be normalized to `<u>` HTML tags.
:::
2020-08-19 03:39:41 +08:00
## Installation
```bash
# With npm
npm install @tiptap/extension-underline
# Or: With Yarn
yarn add @tiptap/extension-underline
```
2020-09-23 18:03:03 +08:00
## Settings
2020-09-10 16:21:24 +08:00
| Option | Type | Default | Description |
| ------ | ------ | ------- | -------------------------------------------- |
| class | string | | Add a custom class to the rendered HTML tag. |
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
2020-09-10 16:21:24 +08:00
| Command | Options | Description |
| --------- | ------- | ------------------------ |
| underline | — | Mark text as underlined. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
2020-09-24 23:33:04 +08:00
* Windows/Linux: `Control` `U`
* macOS: `Cmd` `U`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
[packages/extension-underline/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/)
2020-08-19 03:39:41 +08:00
## Usage
2020-09-24 23:27:26 +08:00
<demo name="Extensions/Underline" highlight="3-5,17,36" />