tiptap/docs/api/nodes/blockquote.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# Blockquote
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-blockquote.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-blockquote)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-blockquote.svg)](https://npmcharts.com/compare/@tiptap/extension-blockquote?minimal=true)
2021-10-02 04:45:12 +08:00
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?
2020-09-23 15:31:05 +08:00
Type <code>>&nbsp;</code> at the beginning of a new line and it will magically transform to a blockquote.
2020-09-21 22:59:28 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
2020-09-21 22:59:28 +08:00
npm install @tiptap/extension-blockquote
2020-10-30 21:24:16 +08:00
# with Yarn
2020-09-21 22:59:28 +08:00
yarn add @tiptap/extension-blockquote
```
2020-08-19 03:39:41 +08:00
2020-09-23 18:03:03 +08:00
## Settings
2021-10-02 04:45:12 +08:00
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
Blockquote.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
2021-10-02 04:45:12 +08:00
### 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()
```
2020-08-19 03:39:41 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
2021-10-02 04:45:12 +08:00
| ----------------- | ------------------------------- | --------------------------- |
| Toggle Blockquote | `Control`&nbsp;`Shift`&nbsp;`B` | `Cmd`&nbsp;`Shift`&nbsp;`B` |
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-blockquote/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-blockquote/)
2020-08-19 03:39:41 +08:00
## Usage
<tiptap-demo name="Nodes/Blockquote"></tiptap-demo>