Kanban

(part of package 'kanban') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

This is a reference page; many components have detailed usage guides here.

Properties

boards

Type: boardItem[]


dragBoards

Type: boolean


dragItems

Type: boolean


gutter

Type: string


itemAddOptions

Type: itemAddOptions


itemHandleOptions

Type: itemHandleOptions


responsivePercentage

Type: boolean Default Value: false


widthBoard

Type: string


Events

buttonClick

callback when the board's button is clicked

Parameters:

el object boardId string event JSEvent


click

callback when any board's item are clicked

Parameters:

taskID string event JSEvent


dragBoard

callback when any board stop drag

Parameters:

el object source object


dragEl

callback when any board's item are clicked

Parameters:

el object source object


dragendBoard

callback when any board stop drag

Parameters:

el object


dragendEl

callback when any board's item stop drag

Parameters:

el object


dropEl

callback when any board's item drop in a board

Parameters:

el object target object source object sibling object


API

addBoards

Adds all the boards to be displayed by the component, any previous boards will be replaced by the new ones

@param {Array<CustomType<svykanban-board.boardItem>>} boards

Parameters:

boardItems boardItem[]


addElement

Adds an item to a specific Board

@param {String} bid the Board Id, if not found the item will be ignored @param {CustomType<svykanban-board.item>} el the item to be added to the Board @param {number} [position] the position to insert the new item at, if not provided it will be inserted at the end

Parameters:

boardID string element object position int (optional)


updateElement

Updates the title of an existing item

@param {String} bid the Board Id, if not found the item will be ignored @param {CustomType<svykanban-board.item>} el the item to be updated, the title of the existing item will be replaced with this one, if not found by id it will be ignored

Parameters:

elementID string element object


Types

boardItem

scripting type: CustomType<svykanban-board.boardItem>

item

scripting type: CustomType<svykanban-board.item>

itemAddOptions

scripting type: CustomType<svykanban-board.itemAddOptions>

itemHandleOptions

scripting type: CustomType<svykanban-board.itemHandleOptions>


Last updated