Skip to main content

editor

Description​

Optional. Contains settings to customize the Kanban editor

Usage​

editor?: {
    show?: boolean,
    autoSave?: boolean,
    debounce?: number,
    placement?: "sidebar" | "modal"
};

Parameters​

  • show - (optional) - turns the editor on or off
  • autoSave - (optional) toggles the autosave feature of the editor
  • debounce - (optional) sets the delay time for autosaving data (only applies when autoSave: true)
  • placement - (optional) defines where the editor appears. Possible values:
    • "sidebar" - shows the editor as a sidebar
    • "modal" - shows the editor in a modal window

Default config​

editor: {
    show: true,
    debounce: 100,
    autoSave: true,
    placement: "sidebar"
}

Example​

new kanban.Kanban("#root", {
    columns,
    cards,
    editor: {
        show: true
        autoSave: true,
        debounce: 2000,
        placement: "modal"
    }
    // other parameters
});

Change log: The placement option was introduced in version 1.6

Related samples: Kanban. Opening the editor in a modal window