Skip to main content

How-tos

This page provides all the information that you need to configure JavaScript Kanban. If you are interested in detailed information about the working principles behind Kanban, refer to the corresponding sections below.

Basic principles

In this section you can find out basic principles of work with Kanban

TopicDescription
InitializationLearn how to initialize Kanban (Example)
ConfigurationLearn how to configure Kanban
CustomizationLearn how to customize Kanban
LocalizationLearn how to localize Kanban (Example)

API reference

In this section you can find out corresponding references of Kanban API

TopicDescription
Kanban methodsLearn how to work with Kanban methods
Event Bus methodsLearn how to work with Event Bus methods
State methodsLearn how to work with State methods
RestDataProvider methodsLearn how to work with RestDataProvider methods
Kanban eventsLearn how to work with Kanban events
Kanban propertiesLearn how to work with Kanban properties

How to work with cards

In these sections you can find out how to perform operations with cards, work with cards data and corfigure cards

Performing operations with cards

TopicDescription
Adding new cardsLearn how to add new cards (Example)
Deleting cardsLearn how to delete cards (Example)
Moving cardsLearn how to move cards (Example)
Selecting cardsLearn how to select cards
Searching for cardsLearn how to search for cards
Unselecting cardsLearn how to unselect cards

Working with card data

TopicDescription
Getting card dataLearn how to get the card data
Loading card dataLearn how to load the initial card data
Parsing card dataLearn how to parse the card data
Serializing card dataLearn how to serialize the card data (Example)
Updating card dataLearn how to update the card data

Configuring cards

TopicDescription
Adding new cardsLearn how to enable/disable an ability to add new cards
Binding cards into columnsLearn how to bind cards into columns
Binding cards into rowsLearn how to bind cards into rows
Configuring a card appearanceLearn how to configure a card appearance
Customizing a card appearanceLearn how to customize a card appearance using templates (Example)
Dragging cardsLearn how to enable/disable an ability to drag-n-drop cards
Editing cardsLearn how to enable/disable an ability to edit cards
Selecting cardsLearn how to enable/disable an ability to select cards
Updating card settingsLearn how to update card settings
Limiting cardsLearn how to limit cards for columns and swimlanes (WIP validation) (Example)

How to work with a card editor

In this section you can find out how to work with a card editor

TopicDescription
Autosaving modeLearn how to enable/disable an editor autosave mode
Configuring an editor appearanceLearn how to configure an editor appearance
Updating editor settingsLearn how to update editor settings

How to work with columns

In these sections you can find out how to perform operations with colums and work with columns data

Performing operations with columns

TopicDescription
Adding new columnsLearn how to add new columns (Example)
Deleting columnsLearn how to delete columns
Moving columnsLearn how to move columns

Working with column data

TopicDescription
Getting card data of the columnLearn how to get the card data of the column
Loading column dataLearn how to load the initial column data
Parsing column dataLearn how to parse the column data
Serializing column dataLearn how to serialize the column data
Updating column dataLearn how to update the column data

How to work with rows (swimlanes)

In these sections you can find out how to perform operations with rows and work with rows data

Performing operations with rows (swimlanes)

TopicDescription
Adding new rowsLearn how to add new rows (swimlanes)
Deleting rowsLearn how to delete rows (swimlanes)
Moving rowsLearn how to move rows (swimlanes)

Working with row (swimlane) data

TopicDescription
Getting card data of the column and rowLearn how to get the card data of the column and row
Loading row dataLearn how to load the initial row data
Parsing row dataLearn how to parse the row data
Serializing row dataLearn how to serialize the row data
Updating row dataLearn how to update the row data

How to work with events

TopicDescription
List of inner eventsSee the list of Kanban inner events
Subscribing on eventsLearn how to subscribe on the inner event
Executing eventsLearn how to execute the inner event
Intercepting eventsLearn how to intercept the inner event
Reordering eventsLearn how to add the inner event into the Event Bus order

How to work with Kanban REST API

TopicDescription
Working with serverLearn how to work with server via REST API (Example)
Loading server data for cardsLearn how to load server data for cards
Loading server data for columnsLearn how to load server data for columns
Loading server data for rowsLearn how to load server data for rows

How to work with Kanban state

TopicDescription
Getting StateStore reactive propertiesLearn how to get an object of the StateStore reactive properties
Getting StateStore propertiesLearn how to get an object of the StateStore properties
Getting StateStore and DataStoreLearn how to get StateStore and DataStore objects

How to work with Kanban Toolbar

TopicDescription
Using Kanban API in the ToolbarLearn how to include and use Kanban API in the Toolbar
Configuring Toolbar controlsLearn how to configure, customize and reorder Toolbar contols (Example)

How to work with TypeScript

TopicDescription
Working with TypeScriptLearn how to work with TypeScript

Any questions left?

info

You can also leave your questions in the comments below!