Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Kanban Board

Link to Figma: tba

Overview

  • The Dynamic Kanban Board is a visual workflow management tool.
  • It displays tasks or items in columns based on their status.
  • Teams can track progress by moving items between stages.
  • It supports drag-and-drop, creation, editing, and deletion of items.
  • It is useful for Agile project management and task tracking.

[IMAGE PLACEHOLDER: Kanban board showing tasks organized in columns with drag-and-drop interaction]

Specs

Tokens

TokenDescription
displayNameDisplay name in structure panel
visibilityPolicySetIdControls visibility based on policy sets
idUnique identifier for programmatic access
titleTitle text displayed at the top of the board
kanbanTitleTranslationsLocalized board title text
iconsRulesCustom icons displayed based on conditions
paddingClassPadding space around the board
elementsColumns of the Kanban board
getStatusesDataSourceIdData source for status list
getStatusesHttpRequestParametersMapHTTP parameters for status request
statusesStatusFieldField used as status identifier
statusesTitleFieldField used as column header
getKanbanItemDataSourceIdData source for Kanban items
getKanbanItemsHttpRequestParametersMapHTTP parameters for item requests
kanbanItemKeyFieldUnique identifier for each item
kanbanItemsStatusFieldField used for item status
kanbanItemTitleTemplateTemplate for item title
kanbanItemSubtitleTemplateTemplate for item subtitle
kanbanItemDescriptionTemplateTemplate for item description
statusPaginationEnables server-side pagination for statuses
statusPaginationPageSizePage size for statuses
kanbanItemPaginationEnables server-side pagination for items
kanbanItemPaginationPageSizePage size for Kanban items
allowUpdatingEnables item updates
updateKanbanItemDataSourceIdData source for updating items
updateKanbanItemHttpRequestParametersMapHTTP parameters for update requests
editDialogDialog used for editing items
allowAddingEnables creation of new items
addDialogDialog used for adding new items
allowDeletingEnables item deletion
deleteKanbanItemDataSourceIdData source for deleting items
deleteKanbanItemHttpRequestParametersMapHTTP parameters for delete requests
deleteConfirmationRequires confirmation before deletion
eventsConfigurable component events
ON_INIT (Events)Event on component initialization
ON_DESTROY (Events)Event on component removal
dataTestIdIdentifier for automated testing
enableAsHotspotEnables guided tour hotspot
guidedTourHotSpotTitleTitle for guided tour hotspot
guidedTourHotSpotDescriptionDescription for guided tour hotspot
displayConditionsConditions for component visibility

...

  • kanbanItemsStatusField – Specifies which field from the Kanban item data source contains the status value.
  • kanbanItemTitleTemplate – Defines the template for displaying the title of each Kanban item.
  • kanbanItemSubtitleTemplate – Defines the template for displaying a subtitle on each Kanban item.
  • kanbanItemDescriptionTemplate – Defines the template for displaying a description on each Kanban item.

...

Styling

(Configured in General Properties)

...

  • statusPagination – Activates server-side pagination for the status data source.
  • statusPaginationPageSize – Sets the number of statuses to load per page.
  • kanbanItemPagination – Activates server-side pagination for the Kanban items data source.
  • kanbanItemPaginationPageSize – Sets the number of Kanban items to load per page.

[IMAGE PLACEHOLDER: Kanban board with styled display name, title with translations, icons, padding, and pagination behavior visualized]

Actions & Variants

(Configured in Events)

...

(Configured in Datasource Properties)

  • allowUpdating – Enables item updating functionality.

  • updateKanbanItemDataSourceId – Data source ID for updating Kanban items.

  • updateKanbanItemHttpRequestParametersMap – Parameters for update requests.

[IMAGE PLACEHOLDER: Kanban board showing update action with drag-and-drop and edit dialog]

  • allowAdding – Enables item creation functionality.

  • addDialog – Dialog used for adding new Kanban items.

[IMAGE PLACEHOLDER: Kanban board showing add action with item creation dialog]

  • allowDeleting – Enables item deletion functionality.

  • deleteKanbanItemDataSourceId – Data source ID for deleting Kanban items.

  • deleteKanbanItemHttpRequestParametersMap – Parameters for delete requests.

  • deleteConfirmation – Requires confirmation before item deletion.

...

Tests

(Configured in Testing Hooks)

...

  • visibilityPolicySetId – Determines the visibility of the component based on specified policy sets.
  • Figma: tba
  • Live style guide: tba

Guidelines

Technical Documentation for Backend Developers

...