mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-14 18:49:02 +08:00
45 lines
1.9 KiB
Markdown
45 lines
1.9 KiB
Markdown
# Italic
|
||
[](https://www.npmjs.com/package/@tiptap/extension-italic)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-italic?minimal=true)
|
||
|
||
Use this extension to render text in *italic*. If you pass `<em>`, `<i>` tags, or text with inline `style` attributes setting `font-style: italic` in the editor’s initial content, they all will be rendered accordingly.
|
||
|
||
Type `*one asterisk*` or `_one underline_` and it will magically transform to *italic* text while you type.
|
||
|
||
::: 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.
|
||
:::
|
||
|
||
## Installation
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-italic
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-italic
|
||
```
|
||
|
||
## Settings
|
||
| Option | Type | Default | Description |
|
||
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
|
||
| HTMLAttributes | `Object` | `{}` | Custom HTML attributes that should be added to the rendered HTML tag. |
|
||
|
||
## Commands
|
||
| Command | Parameters | Description |
|
||
| ------------ | ---------- | -------------------- |
|
||
| setItalic | — | Mark text as italic. |
|
||
| toggleItalic | — | Toggle italic mark. |
|
||
| unsetItalic | — | Remove italic mark. |
|
||
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| -------------- | ------------------ | -------------- |
|
||
| toggleItalic() | `Control` `I` | `Cmd` `I` |
|
||
|
||
## Source code
|
||
[packages/extension-italic/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-italic/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Marks/Italic"></tiptap-demo>
|