> For the complete documentation index, see [llms.txt](https://docs.heisenware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heisenware.com/reference/widgets/display/kanban.md).

# Kanban

Board of cards grouped into stage columns, with drag-and-drop moves and click events

<figure><img src="https://3495989837-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FE5Ketpww1s7TauSAJrJ8%2Fuploads%2Fgit-blob-c7fbab5375fb24c2d345a7da829436065dbaea9b%2Fwidget-kanban.png?alt=media" alt="Kanban board of maintenance tasks in Planned, In progress and Done, each card with a colored edge for its priority" width="1048"><figcaption></figcaption></figure>

A Kanban board groups cards into columns by their stage. Users drag a card to the next column, and the moved card goes to your logic, which stores the new stage. A status field colors the card's edge, for example by priority. Clicks on a card, its title or a column go to your logic too, for example to open the task's details.

**Good for:** maintenance and repair tasks, order and job tracking, shift handover lists.

## Properties

The widget's General tab lists these properties under Receives and Emits. Drop an executor's output, input or trigger onto a row to link it. An example also fills an unlinked widget as demo data in the App Builder.

{% tabs %}
{% tab title="Receives" %}
**`cards`** (from an output, `Array<object>`): The cards to display, grouped into columns by their stage field (`props.stageKey`). At design time the first cards configure the board: stage, title and subtitle keys and the stages (rescan from the canvas menu to redo it).

<details>

<summary>Example</summary>

```json
[
  {
    "id": 1,
    "title": "Check valve",
    "description": "Line 2, weekly",
    "stage": "Not Started"
  },
  {
    "id": 2,
    "title": "Replace filter",
    "description": "Compressor B",
    "stage": "In Progress"
  },
  {
    "id": 3,
    "title": "Calibrate sensor",
    "description": "Tank 4 level",
    "stage": "In Progress"
  },
  {
    "id": 4,
    "title": "Inspect belt",
    "description": "Conveyor 1",
    "stage": "Completed"
  }
]
```

</details>
{% endtab %}

{% tab title="Emits" %}
**`onCardChange`** (into an input, `object`): Writes the moved card (with its stage field updated) after a drag between columns.

**`onColumnClick`** (into an input, `string`): Writes the clicked column's stage value.

**`onCardClick`** (into an input, `object`): Writes the clicked card.

**`onTitleClick`** (into an input, `object`): Writes the card whose title was clicked.
{% endtab %}
{% endtabs %}

## Settings

Double-click the widget in the Page editor to open its settings, grouped in these tabs.

<details>

<summary>Content</summary>

* **Stage key**: Card field whose value names the stage column the card sits in.
* **Title key**: Card field shown as the card's bold title.
* **Subtitle key**: Card field shown under the title; cards without it show none.
* **Status key**: Card field matched against the status mappings to color the card's left edge.
* **Status mappings**: Status values and the color each gives a card's left edge.
  * **Status**: Value of the status field this mapping applies to, compared as text.
  * **Color**: Color of the card's left edge for this status; auto or empty takes the theme's tile color.

</details>

<details>

<summary>Look &#x26; feel</summary>

* **Stages**: Stage names, one column each in this order; dropping a card in a column writes that name to its stage field and emits onCardChange.
* **Card title is clickable**: Renders the title as a link; a click on it emits onTitleClick with the card instead of onCardClick.
* **Empty column text**: Text a column without cards shows; empty says it in the app's language (Drag cards here).

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.heisenware.com/reference/widgets/display/kanban.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
