tiptap/docs/src/docPages/api/nodes/heading.md

35 lines
1.6 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Heading
2020-09-27 16:40:08 +08:00
The Heading extension adds support for headings of different levels. Headings are rendered with `<h1>`, `<h2>`, `<h3>`, `<h4>`, `<h5>` or `<h6>` HTML tags. By default all six heading levels (or styles) are enabled, but you can pass an array to only allow a few levels. Check the usage example to see how this is done.
2020-09-11 03:13:18 +08:00
2020-09-27 16:40:08 +08:00
Type <code>#&nbsp;</code> at the beginning of a new line and it will magically transform to a heading, same for <code>##&nbsp;</code>, <code>###&nbsp;</code>, <code>####&nbsp;</code>, <code>#####&nbsp;</code> and <code>######&nbsp;</code>.
2020-08-19 03:39:41 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-heading
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-heading
```
2020-09-23 18:03:03 +08:00
## Settings
2020-09-27 16:40:08 +08:00
| Option | Type | Default | Description |
| ------ | ------ | ------------------ | --------------------------------------------- |
| class | string | | Add a custom class to the rendered HTML tag. |
2020-11-06 22:44:23 +08:00
| levels | array | [1, 2, 3, 4, 5, 6] | Specifies which heading levels are supported. |
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
| Command | Parameters | Description |
| ------- | ---------- | ------------------------------------------------ |
| heading | level | Creates a heading node with the specified level. |
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
* Windows/Linux: `Control`&nbsp;`Alt`&nbsp;`1-6`
* macOS: `Cmd`&nbsp;`Alt`&nbsp;`1-6`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2020-09-10 23:10:20 +08:00
[packages/extension-heading/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/)
2020-08-19 03:39:41 +08:00
2020-09-10 23:10:20 +08:00
## Usage
<demo name="Nodes/Heading" highlight="3-11,23,42-44" />