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

65 lines
1.7 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Bold
2020-08-20 21:33:16 +08:00
Renders text in **bold** text weight. 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
::: warning Restrictions
2020-08-20 21:33:16 +08:00
The extension will generate the corresponding `<strong>` HTML tags when reading contents of the `Editor` instance. All text marked as 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-08-19 03:39:41 +08:00
*None*
2020-08-20 21:33:16 +08:00
## Commands
| Command | Options | Description |
2020-08-19 03:39:41 +08:00
| ------ | ---- | ---------------- |
| bold | none | Mark text as bold. |
2020-08-20 21:33:16 +08:00
## Keybindings
2020-08-19 03:39:41 +08:00
* Windows & Linux: `Control` + `B`
* macOS: `Command` + `B`
2020-08-20 21:33:16 +08:00
## Usage
2020-08-19 03:39:41 +08:00
```markup
<template>
<div>
<editor-menu-bar :editor="editor" v-slot="{ commands, isActive }">
<button type="button" :class="{ 'is-active': isActive.bold() }" @click="commands.bold">
Bold
</button>
</editor-menu-bar>
<editor-content :editor="editor" />
</div>
</template>
<script>
import { Editor, EditorContent, EditorMenuBar } from 'tiptap'
import { Bold } from 'tiptap-extensions'
export default {
components: {
EditorMenuBar,
EditorContent,
},
data() {
return {
editor: new Editor({
extensions: [
new Bold(),
],
content: `
<p><strong>This is strong</strong></p>
<p><b>And this</b></p>
<p style="font-weight: bold">This as well</p>
<p style="font-weight: bolder">Oh! and this</p>
<p style="font-weight: 500">Cool! Right!?</p>
<p style="font-weight: 999">Up to 999!!!</p>
`,
}),
}
},
beforeDestroy() {
this.editor.destroy()
}
}
</script>
```