tiptap/docs/api/nodes/blockquote.md
2021-10-01 22:45:12 +02:00

1.6 KiB

Blockquote

Version Downloads

The Blockquote extension enables you to use the <blockquote> HTML tag in the editor. This is great to … show quotes in the editor, you know?

Type at the beginning of a new line and it will magically transform to a blockquote.

Installation

# with npm
npm install @tiptap/extension-blockquote

# with Yarn
yarn add @tiptap/extension-blockquote

Settings

HTMLAttributes

Custom HTML attributes that should be added to the rendered HTML tag.

Blockquote.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

Commands

setBlockquote()

Wrap content in a blockquote.

editor.commands.setBlockquote()

toggleBlockquote()

Wrap or unwrap a blockquote.

editor.commands.toggleBlockquote()

unsetBlockquote()

Unwrap a blockquote.

editor.commands.unsetBlockquote()

Keyboard shortcuts

Action Windows/Linux macOS
Toggle Blockquote Control Shift B Cmd Shift B

Source code

packages/extension-blockquote/

Usage