docs.md

Classes

KanbanGhostCard

A Kanban Ghost Card

KanbanBoard

A Kanban Board

KanbanCard

A Kanban Card

KanbanLane

A Kanban Lane

KanbanGhostCard

A Kanban Ghost Card

Kind: global class

• KanbanGhostCard
  • new KanbanGhostCard(board)
  • .grab(card)
  • .show()
  • .hide()
  • .move(x, y)

new KanbanGhostCard(board)

Create a new ghost card

Param	Type	Description
board	KanBanBoard	the board to add to

kanbanGhostCard.grab(card)

Copy the contents of the grabbed card to the ghost

Kind: instance method of KanbanGhostCard

Param	Type	Description
card	KanbanCard	the card to copy

kanbanGhostCard.show()

Show the ghost card

Kind: instance method of KanbanGhostCard

kanbanGhostCard.hide()

Hide the ghost card

Kind: instance method of KanbanGhostCard

kanbanGhostCard.move(x, y)

Move the ghost card

Kind: instance method of KanbanGhostCard

Param	Type	Description
x	number	x coordinate
y	number	y coordinate

KanbanBoard

A Kanban Board

Kind: global class

• KanbanBoard
  • new KanbanBoard(selector)
  • .addLane(lane)
  • .addCard(card, laneID)
  • .findLane(laneID)
  • .findCard(cardID)
  • .putCardInLane(cardID, laneID)
  • .putCardAroundCard(cardID1, cardID2)

new KanbanBoard(selector)

Create a kanban board

Param	Type	Description
selector	string	the selector for the container

kanbanBoard.addLane(lane)

Adds a lane to the board

Kind: instance method of KanbanBoard

Param	Type	Description
lane	KanbanLane	the kanban lane to add

kanbanBoard.addCard(card, laneID)

Adds a card to the board

Kind: instance method of KanbanBoard

Param	Type	Description
card	KanbanCard	the kanban card to add
laneID	laneID	lane to add in

kanbanBoard.findLane(laneID)

Finds a lane on the board

Kind: instance method of KanbanBoard

Param	Type	Description
laneID	string	the lane ID of the lane to find

kanbanBoard.findCard(cardID)

Finds a card on the board

Kind: instance method of KanbanBoard

Param	Type	Description
cardID	string	the card ID of the card to find

kanbanBoard.putCardInLane(cardID, laneID)

Moves a card to a lane at the end

Kind: instance method of KanbanBoard

Param	Type	Description
cardID	string	the card ID to move
laneID	string	the lane ID to put the card in

kanbanBoard.putCardAroundCard(cardID1, cardID2)

Puts a card around a card

Kind: instance method of KanbanBoard

Param	Type	Description
cardID1	string	the card ID to move
cardID2	string	the card ID to put around

KanbanCard

A Kanban Card

Kind: global class

new KanbanCard(id, content, template)

Create a new kanban card

Param	Type	Description
id	string	the selector for the container
content	any	content to be put in the card
template	function	the template to use on the card

KanbanLane

A Kanban Lane

Kind: global class

• KanbanLane
  • new KanbanLane(id, content, template)
  • .toggle()

new KanbanLane(id, content, template)

Create a new ghost card

Param	Type	Description
id	string	the id of the lane
content	string	the content to put in the title
template	function	the template function for the title

kanbanLane.toggle()

Toggle the lane open or minimized

Kind: instance method of KanbanLane