ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat: setHardBreak now keeps splittable marks by default, fix #1934

Browse Source
This commit is contained in:
Philipp Kühn
2021-09-23 09:34:47 +02:00
parent 6c8ff4dc67
commit 377bbb177d
2 changed files with 37 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api/nodes/hard-break.md
View File

@@ -13,10 +13,16 @@ npm install @tiptap/extension-hard-break
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
| Command | Parameters | Description |
| --------- | ---------- | ----------------- |
| hardBreak | — | Add a line break. |
| Command | Parameters | Description |
| ------------ | ---------- | ----------------- |
| setHardBreak | — | Add a line break. |
## Keyboard shortcuts
* `Shift` `Enter`