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

38 lines
1.3 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Bold
Use this extension to render text in **bold**. If you pass `<strong>`, `<b>` tags, or text with inline `style` attributes setting the `font-weight` CSS rule in the editors initial content, they all will be rendered accordingly.
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
Type `**two asterisks**` or `__two underlines__` and it will magically transform to **bold** text while you type.
2020-08-19 03:39:41 +08:00
::: warning Restrictions
The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked bold, regardless of the method will be normalized to `<strong>` HTML tags.
2020-08-19 03:39:41 +08:00
:::
## Installation
```bash
# With npm
npm install @tiptap/extension-bold
# Or: With Yarn
yarn add @tiptap/extension-bold
```
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 |
| ------- | ------- | --------------- |
| bold | — | Mark text bold. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
* Windows/Linux: `Control`&nbsp;`B`
* macOS: `Cmd`&nbsp;`B`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2020-08-21 03:26:25 +08:00
[packages/extension-bold/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bold/)
## Usage
2020-09-24 23:27:26 +08:00
<demo name="Extensions/Bold" highlight="3-5,17,36" />