mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-15 11:09:01 +08:00
72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
# Heading
|
||
Enables you to use headline HTML tags in the editor.
|
||
|
||
## Options
|
||
| Option | Type | Default | Description |
|
||
| ------ | ------ | ------------------ | -------------------------------------------- |
|
||
| class | string | – | Add a custom class to the rendered HTML tag. |
|
||
| levels | Array | [1, 2, 3, 4, 5, 6] | Specifies which headlines are supported. |
|
||
|
||
## Commands
|
||
| Command | Options | Description |
|
||
| ------- | ------- | ----------------------- |
|
||
| heading | level | Creates a heading node. |
|
||
|
||
## Keyboard shortcuts
|
||
* `Control` + `Shift` + `1` → H1
|
||
* `Control` + `Shift` + `2` → H2
|
||
* `Control` + `Shift` + `3` → H3
|
||
* `Control` + `Shift` + `4` → H4
|
||
* `Control` + `Shift` + `5` → H5
|
||
* `Control` + `Shift` + `6` → H6
|
||
|
||
## Usage
|
||
```markup
|
||
<template>
|
||
<div>
|
||
<editor-menu-bar :editor="editor" v-slot="{ commands, isActive }">
|
||
<div>
|
||
<button type="button" :class="{ 'is-active': isActive.heading({ level: 1 }) }" @click="commands.heading({ level: 1})">
|
||
H1
|
||
</button>
|
||
<button type="button" :class="{ 'is-active': isActive.heading({ level: 2 }) }" @click="commands.heading({ level: 2 })">
|
||
H2
|
||
</button>
|
||
</div>
|
||
</editor-menu-bar>
|
||
|
||
<editor-content :editor="editor" />
|
||
</div>
|
||
</template>
|
||
|
||
<script>
|
||
import { Editor, EditorContent, EditorMenuBar } from 'tiptap'
|
||
import { Heading } from 'tiptap-extensions'
|
||
|
||
export default {
|
||
components: {
|
||
EditorMenuBar,
|
||
EditorContent,
|
||
},
|
||
data() {
|
||
return {
|
||
editor: new Editor({
|
||
extensions: [
|
||
Heading({
|
||
levels: [1, 2],
|
||
}),
|
||
],
|
||
content: `
|
||
<h1>This is a headline level 1</h1>
|
||
<h2>This is a headline level 2</h2>
|
||
<h3>This headline will be converted to a paragraph, because it's not defined in the levels option.</h3>
|
||
`,
|
||
}),
|
||
}
|
||
},
|
||
beforeDestroy() {
|
||
this.editor.destroy()
|
||
}
|
||
}
|
||
</script>
|
||
``` |