tiptap/docs/api/marks/italic.md

72 lines
1.9 KiB
Markdown
Raw Normal View History

---
description: Helps to emphasize your text, doesnt bring you closer to Italy though.
---
2020-08-19 03:39:41 +08:00
# Italic
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-italic.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-italic)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-italic.svg)](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 editors initial content, they all will be rendered accordingly.
2020-09-23 18:03:03 +08:00
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.
:::
2020-08-19 03:39:41 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-italic
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-italic
```
2020-09-23 18:03:03 +08:00
## Settings
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Italic.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
2020-12-04 00:05:22 +08:00
2021-10-02 05:25:07 +08:00
### setItalic()
Mark the text italic.
```js
editor.commands.setItalic()
```
### toggleItalic()
Toggle the italic mark.
```js
editor.commands.toggleItalic()
```
### unsetItalic()
Remove the italic mark.
```js
editor.commands.unsetItalic()
```
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| -------------- | ------------------ | -------------- |
| toggleItalic() | `Control`&nbsp;`I` | `Cmd`&nbsp;`I` |
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-italic/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-italic/)
2020-08-19 03:39:41 +08:00
## Usage
<tiptap-demo name="Marks/Italic"></tiptap-demo>