Skip to content

Commit 10fdaf8

Browse files
committed
Mod: update docs to include allowLineBreaks config option
1 parent f17122e commit 10fdaf8

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,12 @@ var editor = EditorJS({
7878

7979
All properties are optional.
8080

81-
| Field | Type | Description |
82-
| ------------ | ---------- | --------------------------- |
83-
| placeholder | `string` | header's placeholder string |
84-
| levels | `number[]` | enabled heading levels |
85-
| defaultLevel | `number` | default heading level |
81+
| Field | Type | Description |
82+
| --------------- | ---------- | ----------------------------------- |
83+
| placeholder | `string` | header's placeholder string |
84+
| levels | `number[]` | enabled heading levels |
85+
| defaultLevel | `number` | default heading level |
86+
| allowLineBreaks | `bool` | allow line breaks. default: `false` |
8687

8788
```javascript
8889
var editor = EditorJS({
@@ -95,7 +96,8 @@ var editor = EditorJS({
9596
config: {
9697
placeholder: 'Enter a header',
9798
levels: [2, 3, 4],
98-
defaultLevel: 3
99+
defaultLevel: 3,
100+
allowLineBreaks: true
99101
}
100102
}
101103
}

0 commit comments

Comments
 (0)