Files
tiptap/docs/src/docPages/api/nodes/horizontal-rule.md
2020-11-18 12:12:34 +01:00

1.2 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

# 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.

Keyboard shortcuts

None

Source code

packages/extension-horizontal-rule/

Usage