Skip to main content

add-comment

Description​

Fires when adding a new comment

Usage​

"add-comment": ({
    id?: string | number,
    cardId: string | number,
    comment: {
        text?: string,
        date?: Date,
        html?: string
    },
    skipProvider?: boolean
}) => void;

Parameters​

The callback of the add-comment event can take an object with the following parameters:

  • id - (optional) the ID of the new comment
  • cardId - (required) the ID of the card, to which the comment to be added
  • comment - (required) the configuration object of the new comment. Here you can specify the following parameters:
    • text - (optional) the text of the new comment
    • date - (optional) the date of the new comment
    • html - (optional) the HTML markup of the new comment. Enable the html property of the editorShape config, to display the HTML markup instead of text
  • skipProvider - (optional) enables/disables preventing the request from being sent to the server
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 "add-comment" event
board.api.on("add-comment", (obj) => {
    console.log(obj.comment);
});

Change log: The event was added in v1.4