1.7 KiB
1.7 KiB
HardBreak
The HardBreak extensions adds support for the <br> HTML tag, which forces a line break.
Installation
# with npm
npm install @tiptap/extension-hard-break
# with Yarn
yarn add @tiptap/extension-hard-break
Settings
| Option | Type | Default | Description |
|---|---|---|---|
| HTMLAttributes | Object |
{} |
Custom HTML attributes that should be added to the rendered HTML tag. |
| keepMarks | Boolean |
true |
Decides whether to keep marks after a line break. Based on the keepOnSplit option for marks. |
Commands
setHardBreak()
Add a line break.
editor.commands.setHeardBreak()
Keyboard shortcuts
| Command | Windows/Linux | macOS |
|---|---|---|
| setHardBreak | Shift EnterControl Enter |
Shift EnterCmd Enter |
Source code
packages/extension-hard-break/