64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
---
|
||
description: Quoting other people will make you look clever.
|
||
icon: double-quotes-l
|
||
---
|
||
|
||
# Blockquote
|
||
[](https://www.npmjs.com/package/@tiptap/extension-blockquote)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-blockquote?minimal=true)
|
||
|
||
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 <code>> </code> at the beginning of a new line and it will magically transform to a blockquote.
|
||
|
||
## Installation
|
||
```bash
|
||
npm install @tiptap/extension-blockquote
|
||
```
|
||
|
||
## Settings
|
||
|
||
### HTMLAttributes
|
||
Custom HTML attributes that should be added to the rendered HTML tag.
|
||
|
||
```js
|
||
Blockquote.configure({
|
||
HTMLAttributes: {
|
||
class: 'my-custom-class',
|
||
},
|
||
})
|
||
```
|
||
|
||
## Commands
|
||
### setBlockquote()
|
||
Wrap content in a blockquote.
|
||
|
||
```js
|
||
editor.commands.setBlockquote()
|
||
```
|
||
|
||
### toggleBlockquote()
|
||
Wrap or unwrap a blockquote.
|
||
|
||
```js
|
||
editor.commands.toggleBlockquote()
|
||
```
|
||
|
||
### unsetBlockquote()
|
||
Unwrap a blockquote.
|
||
|
||
```js
|
||
editor.commands.unsetBlockquote()
|
||
```
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| ----------------- | ------------------------------- | --------------------------- |
|
||
| Toggle Blockquote | `Control` `Shift` `B` | `Cmd` `Shift` `B` |
|
||
|
||
## Source code
|
||
[packages/extension-blockquote/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-blockquote/)
|
||
|
||
## Usage
|
||
https://embed.tiptap.dev/preview/Nodes/Blockquote
|