Skip to main content

scroll

Description​

Fires when scrolling to the specified elements

Usage​

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

Parameters​

The callback of the scroll event can take an object with the following parameters:

  • id - (required) the ID of the target element
  • to - (required) the type of the target element. The available values are "column", "row" and "card"
  • options - (optional) the object of scrolling options. The full list of the scrolling parameters can be found here
info

For handling the inner events you can use the Event Bus methods

Example​

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

Change log: The event was added in v1.2