tiptap/docs/api/marks/bold.md
2021-10-01 23:04:47 +02:00

1.9 KiB
Raw Blame History

Bold

Version Downloads

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.

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

setBold()

Mark text as bold.

editor.commands.setBold()

toggleBold()

Toggle the bold mark.

editor.commands.toggleBold()

unsetBold()

Remove the bold mark.

editor.commands.unsetBold()

Keyboard shortcuts

Command Windows/Linux macOS
toggleBold() Control B Cmd B

Source code

packages/extension-bold/

Usage