tiptap/docs/api/marks/bold.md

72 lines
1.8 KiB
Markdown
Raw Normal View History

---
description: Make your text bold and let it stand out.
---
2020-08-19 03:39:41 +08:00
# Bold
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-bold.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-bold)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-bold.svg)](https://npmcharts.com/compare/@tiptap/extension-bold?minimal=true)
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
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-bold
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-bold
```
2020-09-23 18:03:03 +08:00
## Settings
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
2021-10-02 06:14:44 +08:00
Bold.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
### setBold()
Mark text as bold.
```js
editor.commands.setBold()
```
### toggleBold()
Toggle the bold mark.
```js
editor.commands.toggleBold()
```
### unsetBold()
Remove the bold mark.
```js
editor.commands.unsetBold()
```
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| ------------ | ------------------ | -------------- |
| toggleBold() | `Control`&nbsp;`B` | `Cmd`&nbsp;`B` |
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-bold/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-bold/)
## Usage
<tiptap-demo name="Marks/Bold"></tiptap-demo>