Mod: update docs to include allowLineBreaks config option

editor-js · Dec 17, 2021 · 10fdaf8 · 10fdaf8
1 parent f17122e
commit 10fdaf8
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -78,11 +78,12 @@ var editor = EditorJS({
 
 All properties are optional.
 
-| Field        | Type       | Description                 |
-| ------------ | ---------- | --------------------------- |
-| placeholder  | `string`   | header's placeholder string |
-| levels       | `number[]` | enabled heading levels      |
-| defaultLevel | `number`   | default heading level       |
+| Field           | Type       | Description                         |
+| --------------- | ---------- | ----------------------------------- |
+| placeholder     | `string`   | header's placeholder string         |
+| levels          | `number[]` | enabled heading levels              |
+| defaultLevel    | `number`   | default heading level               |
+| allowLineBreaks | `bool`     | allow line breaks. default: `false` |
 
 ```javascript
 var editor = EditorJS({
@@ -95,7 +96,8 @@ var editor = EditorJS({
       config: {
         placeholder: 'Enter a header',
         levels: [2, 3, 4],
-        defaultLevel: 3
+        defaultLevel: 3,
+        allowLineBreaks: true 
       }
     }
   }