tiptap/docs/api/nodes/horizontal-rule.md

# HorizontalRule
[![Version](https://img.shields.io/npm/v/@tiptap/extension-horizontal-rule.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-horizontal-rule)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-horizontal-rule.svg)](https://npmcharts.com/compare/@tiptap/extension-horizontal-rule?minimal=true)

Use this extension to render a `<hr>` HTML tag. If you pass `<hr>` in the editor’s initial content, it’ll be rendered accordingly.

Type three dashes (<code>---</code>) or three underscores and a space (<code>___ </code>) at the beginning of a new line and it will magically transform to a horizontal rule.

## Installation
```bash
# with npm
npm install @tiptap/extension-horizontal-rule

# with Yarn
yarn add @tiptap/extension-horizontal-rule
```

## Settings
| Option         | Type     | Default | Description                                                           |
| -------------- | -------- | ------- | --------------------------------------------------------------------- |
| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |

## Commands
| Command        | Parameters | Description               |
| -------------- | ---------- | ------------------------- |
| horizontalRule | —          | Create a horizontal rule. |

## Source code
[packages/extension-horizontal-rule/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-horizontal-rule/)

## Usage
<tiptap-demo name="Nodes/HorizontalRule"></tiptap-demo>
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								# HorizontalRule
-												docs: add badges to all extensions

											
										
										
											2021-01-25 17:35:52 +08:00
+								[![Version](https://img.shields.io/npm/v/@tiptap/extension-horizontal-rule.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-horizontal-rule)
 								[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-horizontal-rule.svg)](https://npmcharts.com/compare/@tiptap/extension-horizontal-rule?minimal=true)
-												add a demo and tests to the horizontal rule extension

											
										
										
											2020-09-10 18:55:15 +08:00
+								Use this extension to render a `<hr>` HTML tag. If you pass `<hr>` in the editor’s initial content, it’ll be rendered accordingly.
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								Type three dashes (<code>---</code>) or three underscores and a space (<code>___ </code>) at the beginning of a new line and it will magically transform to a horizontal rule.
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												minor fixes

											
										
										
											2020-09-23 16:01:53 +08:00
+								## Installation
 								```bash
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with npm
-												minor fixes

											
										
										
											2020-09-23 16:01:53 +08:00
+								npm install @tiptap/extension-horizontal-rule
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												minor fixes

											
										
										
											2020-09-23 16:01:53 +08:00
+								yarn add @tiptap/extension-horizontal-rule
 								```
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								## Settings
-												docs: add HTMLAttributes

											
										
										
											2020-11-18 19:12:34 +08:00
+								| Option         | Type     | Default | Description                                                           |
 								| -------------- | -------- | ------- | --------------------------------------------------------------------- |
 								| HTMLAttributes | `Object` | `{}`    | Custom HTML attributes that should be added to the rendered HTML tag. |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												improve the extensions documentation

											
										
										
											2020-08-20 21:33:16 +08:00
+								## Commands
-												move everything around, add more content and a first test for images

											
										
										
											2020-11-03 23:43:35 +08:00
+								| Command        | Parameters | Description               |
 								| -------------- | ---------- | ------------------------- |
 								| horizontalRule | —          | Create a horizontal rule. |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												minor improvements

											
										
										
											2020-09-21 22:59:28 +08:00
+								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-horizontal-rule/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-horizontal-rule/)
-												add a demo and tests to the horizontal rule extension

											
										
										
											2020-09-10 18:55:15 +08:00
 								## Usage
-												replace demo component with custom element

											
										
										
											2021-08-26 05:10:20 +08:00
+								<tiptap-demo name="Nodes/HorizontalRule"></tiptap-demo>