mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-05 04:19:07 +08:00
1.8 KiB
1.8 KiB
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 editor’s initial content, they all will be rendered accordingly.
Type **two asterisks**
or __two underlines__
and it will magically transform to bold text while you type.
::: 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.
:::
Installation
# with npm
npm install @tiptap/extension-bold
# with Yarn
yarn add @tiptap/extension-bold
Settings
Option | Type | Default | Description |
---|---|---|---|
HTMLAttributes | Object |
{} |
Custom HTML attributes that should be added to the rendered HTML tag. |
Commands
Command | Parameters | Description |
---|---|---|
setBold | — | Mark text as bold. |
toggleBold | — | Toggle bold mark. |
unsetBold | — | Remove bold mark. |
Keyboard shortcuts
- Windows/Linux:
Control
B
- macOS:
Cmd
B