Skip to content

Commit ca47ff5

Browse files
[update] the editor property (v2.0)
1 parent 59a1ec9 commit ca47ff5

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/api/config/js_kanban_editor_config.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,42 @@ description: You can learn about the editor config in the documentation of the D
1515
~~~jsx {}
1616
editor?: {
1717
autoSave?: boolean,
18-
debounce?: number
18+
debounce?: number,
19+
placement?: "sidebar" | "modal"
1920
};
2021
~~~
2122

2223
### Parameters
2324

2425
- `autoSave` - (optional) enables/disables an autosave mode of editor
2526
- `debounce` - (optional) time of delay of autosaving data (works with the ***autoSave: true*** parameter only)
27+
- `placement` - (optional) specifies the editor placement. You can set the following values:
28+
- `"sidebar"` - displays the editor as a sidebar
29+
- `"modal"` - displays the editor as a modal window
2630

2731
### Default config
2832

2933
~~~jsx {}
3034
editor: {
3135
autoSave: true,
3236
debounce: 100
37+
placement: "sidebar"
3338
}
3439
~~~
3540

3641
### Example
3742

38-
~~~jsx {4-7}
43+
~~~jsx {4-8}
3944
new kanban.Kanban("#root", {
4045
columns,
4146
cards,
4247
editor: {
4348
autoSave: true,
44-
debounce: 2000
49+
debounce: 2000,
50+
placement: "modal"
4551
}
4652
// other parameters
4753
});
4854
~~~
4955

50-
**Change log:** The property was added in v1.3
56+
**Change log:** The `placement` parameter was added in v2.0

0 commit comments

Comments
 (0)