Skip to main content

scroll

Description​

Triggered when scrolling to specific elements

Usage​

"scroll": ({
    id: string | number,
    to: "column" | "row" | "card",
    options?: object
}) => void;

Parameters​

The callback for the scroll event receives an object with these parameters:

  • id - (required) the ID of the element to scroll to
  • to - (required) the type of element to scroll to. Possible values: "column", "row", or "card"
  • options - (optional) an object with scrolling options. You can find the full list of parameters here
info

To work with inner events, you can use the Event Bus methods

Example​

// create Kanban
const board = new kanban.Kanban("#root", {
    columns,
    cards
});
// listen for the "scroll" event
board.api.on("scroll", (obj) => {
    console.log(obj);
});

Change log: This event was introduced in v1.2