mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-24 01:17:50 +08:00
53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
---
|
||
description: Mom, look! I wrote a paragraph on the Internet.
|
||
icon: paragraph
|
||
---
|
||
|
||
# Paragraph
|
||
[](https://www.npmjs.com/package/@tiptap/extension-paragraph)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-paragraph?minimal=true)
|
||
|
||
Yes, the schema is very strict. Without this extension you won’t even be able to use paragraphs in the editor.
|
||
|
||
:::warning Breaking Change from 1.x → 2.x
|
||
Tiptap 1 tried to hide that node from you, but it has always been there. You have to explicitly import it from now on (or use `StarterKit`).
|
||
:::
|
||
|
||
## Installation
|
||
```bash
|
||
npm install @tiptap/extension-paragraph
|
||
```
|
||
|
||
## Settings
|
||
|
||
### HTMLAttributes
|
||
Custom HTML attributes that should be added to the rendered HTML tag.
|
||
|
||
```js
|
||
Paragraph.configure({
|
||
HTMLAttributes: {
|
||
class: 'my-custom-class',
|
||
},
|
||
})
|
||
```
|
||
|
||
## Commands
|
||
|
||
### setParagraph()
|
||
Transforms all selected nodes to paragraphs.
|
||
|
||
```js
|
||
editor.commands.setParagraph()
|
||
```
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| -------------- | ----------------------------- | ------------------------- |
|
||
| setParagraph() | `Control` `Alt` `0` | `Cmd` `Alt` `0` |
|
||
|
||
## Source code
|
||
[packages/extension-paragraph/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-paragraph/)
|
||
|
||
## Usage
|
||
https://embed.tiptap.dev/preview/Nodes/Paragraph
|