Skip to Content
Docs
Views

Kanban

Turn a typed status column into a board.

Kanban uses the same records, query and mutation actions as the table. Group by a finite status field and show only the properties useful for scanning cards.

Card settings

Open View → Card settings to select the card title and visible properties. Properties and labels use checkboxes that remain open for multiple changes. The grouping field remains under View → Group. On mobile, choices stay inside the view drawer and Back restores the originating control. Short menus do not force a scrollbar; long lists remain scrollable.

Configuration example

Start from the React quick start or Vue quick start. The following file extends their product catalog. Pass this configuration through getTableConfig in React or config in Vue.

pipeline-config.ts
import { defineTableConfig } from "@/components/ui/yayaw-table/config/helpers";
import { productConfig } from "./product-config";

export const pipelineConfig = defineTableConfig({
  ...productConfig,
  table: {
    ...productConfig.table,
    displayModes: ["table", "kanban"],
    defaultDisplayMode: "kanban",
    allowEdit: true,
    enableColumnFilters: true,
    enableAdvancedFilters: true,
    enableViews: true,
    allowViewSave: true,
    allowInlineEdit: true,
    enableGrouping: true,
    kanban: {
      groupBy: "status",
      titleColumn: "name",
      cardColumnIds: ["price", "stock"],
      showCardLabels: true,
    },
  },
});
pipeline-config.ts
import { defineTableConfig } from "@/components/ui/yayaw-table-vue/config";
import { productConfig } from "./product-config";

export const pipelineConfig = defineTableConfig({
  ...productConfig,
  table: {
    ...productConfig.table,
    displayModes: ["table", "kanban"],
    defaultDisplayMode: "kanban",
    allowEdit: true,
    enableColumnFilters: true,
    enableAdvancedFilters: true,
    enableViews: true,
    allowViewSave: true,
    allowInlineEdit: true,
    enableGrouping: true,
    kanban: {
      groupBy: "status",
      titleColumn: "name",
      cardColumnIds: ["price", "stock"],
      showCardLabels: true,
    },
  },
});

Persist a card move

Moving a card between editable lanes updates its grouping field through update(id, patch). Supply the action and editing permissions. An inline-only table (allowEdit: false) must enable allowInlineEdit and explicitly set inlineEdit: true on its single-value grouping column. canEditRow still applies to each card. Writes use the column’s accessorKey when configured and preserve the type of a matching option value. The server must validate allowed transitions and return a failed result when a transition is refused. Use stable option values such as draft, active, and archived; labels can be translated independently.

With kanban.allowDragUpdate, cards drag from their grip handle. Set kanban.dragFromCard: true to start a drag from anywhere on the card: a short click or tap still opens the record, and the card's checkbox, links and menus keep working. Whole-card mode hides the redundant grip. Keyboard users keep the React drag activator, revealed on focus; a focused Vue card moves with Alt+Shift+Left/Right.

Keep the board understandable

titleColumn supplies the card title and cardColumnIds supplies its properties; without it, every data property except the title and the grouped column is shown. Search, filtering and saved views still apply. Paginated server data only represents the rows actually retrieved; do not treat a lane count as a database-wide workflow count without a matching server contract. See the pipeline recipe.

Build a status board

Keep the three status options as lanes and show only the title and stock. Connect editableActions so moving a card persists its status.

Copy this complete configuration beside product-config.ts. Use () => exampleConfig as React’s getTableConfig, or :config="exampleConfig" in Vue.

Expand ↗

Sample data. Changes stay in this preview.

Expand ↗

Sample data. Changes stay in this preview.

Show labels on richer cards

Expose price and stock with their labels when the board is used for review. Table-only density and footer controls are hidden in Kanban.

Copy this complete configuration beside product-config.ts. Use () => exampleConfig as React’s getTableConfig, or :config="exampleConfig" in Vue.

Expand ↗

Sample data. Changes stay in this preview.

Expand ↗

Sample data. Changes stay in this preview.

Server lanes

For a complete board with independent lane pagination, configure table.kanban.server. Its groups(signal) callback returns { value, label, totalCount }[]; counts cover the complete authorized query. rows(group, cursor, signal) returns { rows, nextCursor }, where null ends that lane. The first cursor is null. Each lane loads independently and retains its rows and cursor on failure.

Set queryKey to a stable serialization of filters, search, sorting, account scope and refresh revision. Capture that query in the callbacks and respect AbortSignal. Changing the key discards the old board. The server must enforce permissions for both counts and pages. Never derive totals from the loaded page.

Optional getRowId(row) defaults to String(row.id). onActivate(row) owns record navigation. labels can translate loading, retry, loadMore, and empty. Remote boards support card moves in both React and Vue with kanban.allowDragUpdate: true, the table’s update action and the same editing permissions as local boards. dragFromCard: true enables whole-card dragging; otherwise use the grip. Whole-card mode has no visible grip. Both remote editions let keyboard users move the focused card with Alt+Shift+Left/Right, without visible arrow buttons. Only visible lanes are offered as targets.

A move saves one record, then reloads the authorized groups and their first pages, so counts, filters, sorting and cursors reflect the server’s result. While the move is pending, further moves and lane paging are disabled. A refused write leaves the card in place, shows an error and permits retry. Changing the query or account discards stale read and write completions. Moving within a lane does not persist manual ordering. The board’s configured grouping field must remain active to move cards.

Selection, bulk commands and grid pagination still do not apply to incomplete remote lanes. Use the grid for bulk work. Workflow-derived lanes need a domain transition action; do not write a calculated stage as an ordinary status.

Lanes per view

kanban.lanes keeps the lane order and the hidden lanes of each grouping column, for example { "status": { "order": ["won", "lead"], "hidden": ["lost"] } }. Lanes the order does not name follow in their usual order, and an order never creates an empty lane. Hidden lanes hide their cards, and the board lists them below it. A saved view carries its own kanban.lanes, so switching views switches lanes; table.kanban.lanes is the default for the grouping columns a view does not name, and each column keeps its own lanes when the grouping changes and back.

In View → Card settings, each lane of the grouping column can be shown or hidden and moved up or down, and a reset returns to the default lanes. These are view changes, saved like the card properties. Server lanes (kanban.server) are ordered and hidden the same way.

Avatars

kanban.avatar (true, or { nameColumn, imageColumn, shape }) shows an avatar before each card title: the image of imageColumn when it loads, else up to two initials on a stable color derived from nameColumn (by default, the title). shape is "circle" (default) or "square". Beside the title the avatar is decorative. The option is saved with the view's card settings.