api.on()

Description

Allows attaching a handler to the inner events

Usage

api.on(
    event: string,
    handler: function
    config?: { intercept?: boolean, tag?: number | string | symbol }
): void;

Parameters

• event - (required) an event to be fired
• handler - (required) a handler to be attached (the handler arguments will depend on the event to be fired)
• config - (optional) an object that stores the following parameters:
  • intercept - (optional) if you set intercept: true during event listener creation, this event listener will run before all others
  • tag - (optional) an action tag. You can use the tag name to remove an action handler via the detach method

Events

info

The full list of the Kanban internal events can be found here

Example

// create Kanban
const board = new kanban.Kanban("#root", {
    columns,
    cards
});
// output the card data in console when its moving
board.api.on("move-card", ({ id, columnId }) => {
    console.log({ id, columnId });
}, {tag: "move"});

Change log: The config.tag and config.intercept parameters were added in v1.7