Zum Hauptinhalt springen

api.on()

Beschreibung​

Ermöglicht das Anhängen eines Handlers an interne Ereignisse

Verwendung​

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

Parameter​

  • event - (erforderlich) ein auszulösendes Ereignis
  • handler - (erforderlich) ein anzuhängender Handler (die Argumente des Handlers hängen vom ausgelösten Ereignis ab)
  • config - (optional) ein Objekt, das folgende Parameter enthält:
    • intercept - (optional) wenn Sie beim Erstellen des Ereignis-Listeners intercept: true setzen, wird dieser Listener vor allen anderen ausgeführt
    • tag - (optional) ein Aktions-Tag. Sie können den Tag-Namen verwenden, um einen Aktions-Handler über die detach Methode zu entfernen

Ereignisse​

Info

Die vollständige Liste der internen Kanban-Ereignisse finden Sie hier

Beispiel​

// Kanban erstellen
const board = new kanban.Kanban("#root", {
    columns,
    cards
});
// gibt die Kartendaten in der Konsole aus, wenn sie verschoben wird
board.api.on("move-card", ({ id, columnId }) => {
    console.log({ id, columnId });
}, {tag: "move"});

Änderungsprotokoll: Die Parameter config.tag und config.intercept wurden in Version 1.7 hinzugefügt