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

28 lines
1.2 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Bold
2020-08-21 00:15:35 +08:00
This extension is used 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 will all be rendered accordingly.
2020-08-19 03:39:41 +08:00
Type `**two asterisks**` or `__two underlines__` and the it will be magically transformed 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
:::
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 |
| ------- | ------- | --------------- |
| bold | — | Mark text bold. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
2020-08-19 03:39:41 +08:00
* Windows & Linux: `Control` + `B`
* macOS: `Command` + `B`
2020-08-21 00:14:41 +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-08-28 19:20:49 +08:00
<demo name="Extensions/Bold" highlight="3-5,17,36" />