Layout

KanbanBoard

Organizes controlled workflow columns with keyboard, pointer, and touch movement requests.

View preview API reference Figma behavior note

FrameworksAstro · React · Elements

Registry commandlumen add KanbanBoard

InteractionNative markup

Design sourceBehavior-only contract

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

Planned

Release notesDocs

In progress

Released

View KanbanBoard code

Framework usage

Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.

---
import {
  Badge,
  Button,
  Card,
  KanbanBoard,
  KanbanColumn
} from '@santi020k/lumen-astro'

const columns = [
  { label: 'Planned', value: 'planned' },
  { label: 'In progress', value: 'active' },
  { label: 'Released', value: 'released' }
]
---

<KanbanBoard aria-label="Editorial workflow" style="--ui-kanban-column-min-height: 12rem">
  {columns.map((column, index) => (
    <KanbanColumn value={column.value}>
      <h3>{column.label}</h3>
      {index === 0 && (
        <Card data-ui-kanban-item="release-notes">
          <Button
            aria-label="Move Release notes"
            data-ui-kanban-handle
            draggable="true"
            size="sm"
            variant="ghost"
          >Move</Button>
          <strong>Release notes</strong>
          <Badge variant="secondary">Docs</Badge>
        </Card>
      )}
    </KanbanColumn>
  ))}
</KanbanBoard>

'use client'

import { Button, Card, KanbanBoard, KanbanColumn, useKanban } from '@santi020k/lumen-react'

export function EditorialBoard() {
  const kanban = useKanban({
    onMoveRequest: ({ itemId, toColumn }) =>
      console.log(`Move ${itemId} to ${toColumn}`)
  })

  return (
    <KanbanBoard {...kanban.rootProps} aria-label="Editorial workflow">
      <KanbanColumn value="planned" {...kanban.getColumnProps('planned')}>
        <Card as="article" {...kanban.getItemProps('draft')}>
          <Button {...kanban.getHandleProps('draft')} aria-label="Move Draft article">
            Move
          </Button>
          <strong>Draft article</strong>
        </Card>
      </KanbanColumn>
      <KanbanColumn value="published" {...kanban.getColumnProps('published')} />
    </KanbanBoard>
  )
}

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-kanban-board aria-label="Editorial workflow" style="--ui-kanban-column-min-height: 12rem">
  {columns.map((column, index) => (
    <lumen-kanban-column value={column.value}>
      <h3>{column.label}</h3>
      {index === 0 && (
        <lumen-card data-ui-kanban-item="release-notes">
          <lumen-button
            aria-label="Move Release notes"
            data-ui-kanban-handle
            draggable="true"
            size="sm"
            variant="ghost">Move</lumen-button>
          <strong>Release notes</strong>
          <lumen-badge variant="secondary">Docs</lumen-badge>
        </lumen-card>
      )}
    </lumen-kanban-column>
  ))}
</lumen-kanban-board>

Edit KanbanBoard in browser

Framework differences

React: Connect useKanban to the board, columns, cards, and handles. Your application owns persistence and decides whether a requested move is accepted.

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

pnpm add @santi020k/lumen-astro

pnpm add @santi020k/lumen-astro

lumen add KanbanBoard

lumen add KanbanBoard

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add KanbanBoard --target react

lumen add KanbanBoard --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add KanbanBoard --target elements

lumen add KanbanBoard --target elements

API reference

Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.

Attribute	Values	Default	Description
ui:kanban-move-request	CustomEvent<LumenKanbanMoveDetail>	-	Requests a controlled move without changing item ownership or persistence.
data-ui-kanban-item	stable item id	required per movable item	Identifies each movable card with its stable application id.
data-ui-kanban-handle	descendant attribute	required per movable item	Marks the dedicated keyboard, pointer, and touch movement control.
class, className	string	""	Merges custom classes with the generated ui-* root classes.
...native attributes	HTML attributes	-	Forwards standard attributes to the root element unless the component consumes them.