@tiptap/extension-blockquote

What is @tiptap/extension-blockquote?

@tiptap/extension-blockquote is an extension for the Tiptap editor that allows users to easily add and manage blockquotes within their rich text content. It provides a simple way to include blockquote formatting, making it easier to highlight quotes or important text in a visually distinct manner.

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

Adding a Blockquote

This code demonstrates how to add the Blockquote extension to a Tiptap editor instance and toggle a blockquote in the editor content.

import { Blockquote } from '@tiptap/extension-blockquote';
import { Editor } from '@tiptap/core';

const editor = new Editor({
  extensions: [
    Blockquote,
  ],
  content: '<p>Hello World!</p>',
});

editor.chain().focus().toggleBlockquote().run();

Customizing Blockquote Styling

This code shows how to extend the Blockquote extension to add custom styling attributes and apply custom CSS to the blockquote element.

import { Blockquote } from '@tiptap/extension-blockquote';
import { Editor } from '@tiptap/core';
import { css } from 'styled-components';

const CustomBlockquote = Blockquote.extend({
  addAttributes() {
    return {
      class: {
        default: 'custom-blockquote',
      },
    };
  },
});

const editor = new Editor({
  extensions: [
    CustomBlockquote,
  ],
  content: '<p>Hello World!</p>',
});

const styles = css`
  .custom-blockquote {
    border-left: 4px solid #ccc;
    padding-left: 16px;
    color: #666;
  }
`;

editor.chain().focus().toggleBlockquote().run();

Other packages similar to @tiptap/extension-blockquote

prosemirror-schema-basic

The prosemirror-schema-basic package provides a basic schema for ProseMirror, including blockquote functionality. It is more low-level compared to @tiptap/extension-blockquote and requires more manual setup and configuration.

quill

Quill is a rich text editor that includes built-in support for blockquotes. It provides a more comprehensive editor experience with a wide range of formatting options, including blockquotes, but may be more heavyweight compared to the focused functionality of @tiptap/extension-blockquote.

README

@tiptap/extension-blockquote

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.

Changelog

2.3.1 (2024-04-30)

Note: Version bump only for package tiptap