> For the complete documentation index, see [llms.txt](https://readme.directual.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://readme.directual.com/web-pages/components/kanban.md).

# Kanban

[Live-demo](https://kanban.directual.app/)

<figure><img src="/files/l92IuD8dLwRMw8nSU02s" alt=""><figcaption></figcaption></figure>

## Component Overview

The Kanban component serves several purposes:

* Display data
* Edit data (including drag and drop between stages-columns)
* Support role-based access control.

### Step 1. Configuring API-endpoint

<figure><img src="/files/TE9By9NhtBRj3C6OWPu5" alt=""><figcaption></figcaption></figure>

Choose the endpoint, which includes the following fields:

* **Stage (column)** — a `link` field, linked with a directory structure
* **Weight** — a `decimal` field. Sorting within a column from small to large ↓. As soon as the user dragged an item the weight is saved from 0 to N for the whole column.

{% hint style="info" %}
If you want to drag and drop objects, `ID`, `weight` and `stage` fields have to be available both for reading and writing.&#x20;
{% endhint %}

### Step 2. Configuring Kanban

<figure><img src="/files/9JDqxpjD6pIWNMT9RGFq" alt=""><figcaption></figcaption></figure>

1. Choose the stage (column field)
2. Choose weight field
3. Choose enable or disable drag and drop
4. Click "Reset the list" to get the stages from the linked data structure (that is a kind of directory)

<figure><img src="/files/IE4Ao5VYzCxocdFAjcQw" alt=""><figcaption><p>Stages directory data structure</p></figcaption></figure>

### Step 3. Configure Cards View and Actions

Follow the same principles as in the [Cards component](/web-pages/components/legacy-components/cards.md).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://readme.directual.com/web-pages/components/kanban.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.