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: Array<CustomType<svykanban-board.boardItem>>

---

dragBoards

Type: Boolean

---

dragItems

Type: Boolean

---

gutter

Type: String

---

itemAddOptions

Type: CustomType<svykanban-board.itemAddOptions>

---

itemHandleOptions

Type: CustomType<svykanban-board.itemHandleOptions>

---

responsivePercentage

Type: Boolean Default Value: false

---

widthBoard

Type: String

---

Events

buttonClick(el,boardId,event)

callback when the board's button is clicked

Parameters:

• {Object} el

• {String} boardId

• {JSEvent} event

---

click(taskID,event)

callback when any board's item are clicked

Parameters:

• {String} taskID

• {JSEvent} event

---

dragBoard(el,source)

callback when any board stop drag

Parameters:

• {Object} el

• {Object} source

---

dragEl(el,source)

callback when any board's item are clicked

Parameters:

• {Object} el

• {Object} source

---

dragendBoard(el)

callback when any board stop drag

Parameters:

• {Object} el

---

dragendEl(el)

callback when any board's item stop drag

Parameters:

• {Object} el

---

dropEl(el,target,source,sibling)

callback when any board's item drop in a board

Parameters:

• {Object} el

• {Object} target

• {Object} source

• {Object} sibling

---

API

addBoards(boardItems)

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

Parameters:

• {Array<boardItem>} boardItems An array of board items to be displayed, replacing any existing boards.

---

addElement(boardID,element,position)

Adds an item to a specific Board

Parameters:

• {String} boardID The Board Id, if not found the item will be ignored

• {Object} element The item to be added to the Board

• {Number} [position] The position to insert the new item at, if not provided it will be inserted at the end

---

updateElement(elementID,element)

Updates the title of an existing item

Parameters:

• {String} elementID The Board Id, if not found the item will be ignored

• {Object} element 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

---

Types

boardItem

scripting type: CustomType<svykanban-board.boardItem>

• class

  • Type: styleclass

• dragTo

  • Type: string[]

• id

  • Type: string

• item

  • Type: item[]

• tabindex

  • Type: string

• title

  • Type: string

item

scripting type: CustomType<svykanban-board.item>

• class

  • Type: styleclass

• id

  • Type: string

• priority

  • Type: string

• title

  • Type: string

itemAddOptions

scripting type: CustomType<svykanban-board.itemAddOptions>

• class

  • Type: string

• content

  • Type: string

  • Default Value: "+"

• enabled

  • Type: boolean

  • Default Value: false

• footer

  • Type: boolean

itemHandleOptions

scripting type: CustomType<svykanban-board.itemHandleOptions>

• customCssHandler

  • Type: string

• customCssIconHandler

  • Type: string

• customHandler

  • Type: string

• enabled

  • Type: boolean

  • Default Value: false

• handleClass

  • Type: string

---