@tiptap/extension-horizontal-rule

What is @tiptap/extension-horizontal-rule?

@tiptap/extension-horizontal-rule is an extension for the Tiptap editor that allows users to insert horizontal rules (also known as horizontal lines) into their rich text content. This can be useful for visually separating sections of content.

What are @tiptap/extension-horizontal-rule's main functionalities?

Insert Horizontal Rule

This feature allows you to insert a horizontal rule into the editor. The code sample demonstrates how to import the HorizontalRule extension, initialize the Tiptap editor with it, and programmatically insert a horizontal rule.

import { HorizontalRule } from '@tiptap/extension-horizontal-rule';
import { Editor } from '@tiptap/core';

const editor = new Editor({
  extensions: [
    HorizontalRule,
  ],
});

// To insert a horizontal rule programmatically
editor.chain().focus().setHorizontalRule().run();

Custom Styling for Horizontal Rule

This feature allows you to customize the styling of the horizontal rule. The code sample demonstrates how to extend the HorizontalRule extension to add a custom class to the horizontal rule element, and then initialize the Tiptap editor with this customized extension.

import { HorizontalRule } from '@tiptap/extension-horizontal-rule';
import { Editor } from '@tiptap/core';

const CustomHorizontalRule = HorizontalRule.extend({
  renderHTML({ HTMLAttributes }) {
    return ['hr', { class: 'custom-horizontal-rule', ...HTMLAttributes }];
  },
});

const editor = new Editor({
  extensions: [
    CustomHorizontalRule,
  ],
});

Other packages similar to @tiptap/extension-horizontal-rule

prosemirror-schema-basic

prosemirror-schema-basic provides a basic schema for ProseMirror, which includes support for horizontal rules. It is more general-purpose compared to @tiptap/extension-horizontal-rule, as it provides a full schema for a basic rich text editor.

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It includes built-in support for horizontal rules, among many other features. Quill is a more comprehensive solution compared to @tiptap/extension-horizontal-rule, which is a specific extension for the Tiptap editor.

slate

Slate is a completely customizable framework for building rich text editors. It allows developers to define their own schema and includes support for horizontal rules. Slate offers more flexibility and customization options compared to @tiptap/extension-horizontal-rule.

README

@tiptap/extension-horizontal-rule

Introduction

Tiptap is a headless wrapper around ProseMirror – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as New York Times, The Guardian or Atlassian.

Official Documentation

Documentation can be found on the Tiptap website.

License

Tiptap is open sourced software licensed under the MIT license.