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

27 lines
1.1 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Italic
2020-09-10 17:53:03 +08:00
This extension is used to render text in *italic*. If you pass `<em>`, `<i>` tags, or text with inline `style` attributes setting `font-style: italic` in the editors initial content, they all will be rendered accordingly.
::: warning Restrictions
The extension will generate the corresponding `<em>` HTML tags when reading contents of the `Editor` instance. All text marked italic, regardless of the method will be normalized to `<em>` HTML tags.
:::
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Options
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 |
| ------- | ------- | ----------------- |
| italic | — | Mark text italic. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
2020-08-19 03:39:41 +08:00
* Windows & Linux: `Control` + `I`
* macOS: `Command` + `I`
## Source Code
2020-08-21 03:26:25 +08:00
[packages/extension-italic/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/)
2020-08-19 03:39:41 +08:00
## Usage
2020-08-28 19:20:49 +08:00
<demo name="Extensions/Italic" highlight="3-5,17,36" />