Files
tiptap/docs/src/docPages/api/extensions/horizontal-rule.md
2020-09-23 12:03:03 +02:00

1.1 KiB
Raw Blame History

HorizontalRule

Use this extension to render a <hr> HTML tag. If you pass <hr> in the editors initial content, itll be rendered accordingly.

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

Installation

# With npm
npm install @tiptap/extension-horizontal-rule

# Or: With Yarn
yarn add @tiptap/extension-horizontal-rule

Settings

Option Type Default Description
class string Add a custom class to the rendered HTML tag.

Commands

Command Options Description
horizontalRule Create a horizontal rule.

Keyboard shortcuts

None

Source code

packages/extension-horizontal-rule/

Usage