On this page
@addTagHelper *, Webority.Ui.RazorSaving a move
Use move-url to save each drop: a refused save puts the card back and says why.
New
2Nothing here
Proposal
1Nothing here
Negotiation
2Nothing here
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
Guarded drops
Limit which columns a card may enter, so a board can only move work along the agreed route.
To do
2Nothing here
In development
1Nothing here
In testing
1Nothing here
Done
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
Decide on a drop
Ask for a decision before a card lands in a column that needs one, and keep the card put on cancel.
New
2Nothing here
Proposal
1Nothing here
Negotiation
2Nothing here
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
Filtering
Narrow a long board to the cards a person needs, by company or owner, without losing the columns.
New
2No deals match
Proposal
1No deals match
Negotiation
2No deals match
Closed
0No deals match
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
Long columns
Show a long column five at a time, and keep a read-only board still so a long list stays easy to scan.
In testing
1Nothing here
Done
12Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
A board that fits the screen
Fill sizes the board to the screen from 768px up: the viewport's height less --wui-kanban-fill-offset, 240px by default. Each column's cards scroll inside the column under its fixed head, so a long column never scrolls the page and every column stays under the pointer while a card is carried. Carry a card near a column's top or bottom edge and that column's list scrolls.
To do
30Nothing here
In development
1Nothing here
In testing
1Nothing here
Done
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
Every option
Every value of every prop, one cell each.
columns
tone="neutral"
neutral
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
tone="primary"
primary
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
tone="info"
info
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
tone="success"
success
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
tone="warning"
warning
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
tone="danger"
danger
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
accept-from="negotiation"
Negotiation
1Nothing here
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
collapsible="true" (folds to a strip)
New
1Nothing here
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
visible-limit="1" on a column
New
2Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
cards
app-kanban-card in a column: two deals
New
2Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
refresh() on the element
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
renderCard
card content: its children, company only
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
renderColumnActions
app-kanban-column-actions: a plus in each head
New
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
getCardKey
key="d1" on app-kanban-card (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
getCardColumn
column: the enclosing app-kanban-column (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
getCardValue
value="450000" on app-kanban-card
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
cardLabel
label="Sharma Textiles, ₹4,50,000" on app-kanban-card
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
isCardLocked
locked="true" on a card
Closed
1Nothing here
Open
0Closed deals stay closed
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
onLocked
wui:kanban:locked (event): the page says why
Done
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
onMove
move-url="/Demo/Board?handler=Move"
New
1Nothing here
Proposal
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
card-url="/Demo/Board?handler=Card"
New
1Nothing here
Proposal
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
moveCard(key, to) on the element
New
1Nothing here
Proposal
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
wui:kanban:move (event, cancelable)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
wui:kanban:moved (event, after a save)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
wui:kanban:failed (event, a save failed)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
accept
accept (script hook): refuses a move to New
Negotiation
1Nothing here
New
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
filter
setFilter(fn): deals over ₹5 lakh only
Negotiation
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
boardId
board-id="matrix-board"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
ariaLabel
aria-label="Deals by stage"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
columnsLabel
columns-label: the column switcher name, on phones
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
emptyText
empty-text="No deals yet"
Closed
0No deals yet
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
readOnly
read-only="false" (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
read-only="true"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
swipeHint
swipe-hint="false" (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
swipe-hint="true" (phones)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
fill
fill="false" (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
fill="true" (fits the screen from md up)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
columnWidth
column-width="200"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
fillOffset
fill-offset="120" (with fill)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
headLayout
head-layout="inline" (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
head-layout="stacked"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
truncateHeads
truncate-heads="false" (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
truncate-heads="true"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
activeCardKey
active-card-key="d2"
New
2Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
summaryFormat
summary-format="number" over a count
New
2Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
summary-format="currency"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
summary-format="compact"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
summaryUnit
summary-unit="rupees" (default)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
summary-unit="paise"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
linkComponent
href (linkComponent on React)
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
className
class="mb-3"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
id
id="matrix-board"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
expandLabel
expand-label="Open {title}"
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
collapseLabel
collapse-label="Fold {title}"
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
wui:kanban:collapse (event): a column folds or opens
Closed
0Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
helpText
help-text: keyboard instructions, read aloud
New
1Nothing here
Press Space to pick up the card, then Space to drop it.
swipeHintText
swipe-hint-text="Swipe to change column"
New
1Nothing here
Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel.
Guidance
What to do, and what to avoid.
Use it when
- Work moves through a few fixed stages and people move it themselves: a pipeline, a sprint, a support queue.
- Seeing everything at a stage at once matters more than sorting or paging.
- Each move is one saved change, such as a status or a stage.
Reach for something else when
- The list is long and needs sorting, paging or bulk edits. → AppDataTable
- The stages are a fixed path someone walks through once. → AppStepper
- You only need to show progress, not move work. → AppProgress
Reference
Try every prop, read the full list, and check keyboard and screen reader behaviour.
30 props. The 3 most used come first.
Used on most screens 3 props
| Prop | Type | Default | Description |
|---|---|---|---|
| board-iddefault - | string | - | Remembers which columns are folded per browser, under this id. |
| read-onlydefault false | bool | false | No card can be moved. |
| empty-textdefault Nothing here | string | Nothing here | Text of an empty column. |
Less common 27 props
| Prop | Type | Default | Description |
|---|---|---|---|
| aria-labeldefault Board | string | Board | The accessible name of the board region. |
| move-urldefault - | string | - | Where a move POSTs card, from, to and index. Without it a move stays in the page. Server-only: React saves in onMove. |
| card-urldefault - | string | - | GET with card= answering the fresh card, fetched after a step modal saves a move. Server-only. |
| swipe-hintdefault false | bool | false | On phones, a Swipe sideways or tap a column line under the column switcher. |
| filldefault false | bool | false | From md up the board fits the screen and each column's cards scroll inside the column under its fixed head. Phones keep the one-column layout. |
| column-widthdefault 288 | int | 288 | The width of each column in px. |
| fill-offsetdefault 240 | int | 240 | The px taken off the viewport height when the board fills the screen, in place of the 240px default. |
| head-layoutdefault inline | inline | stacked | inline | Stacked puts each stage name on its own line, with no tone dot. |
| truncate-headsdefault false | bool | false | Keeps each stage name on one line, ends a long one in an ellipsis and shows the full name on hover. |
| active-card-keydefault - | string | - | The key of the card just added; it is highlighted until the next render. |
| summary-formatdefault - | number | currency | compact | - | Makes each column's summary the sum of its visible cards' values, in this format. The values come from a function in code. |
| summary-unitdefault rupees | rupees | paise | rupees | The unit of the card values that summary-format adds up. |
| columns-labeldefault Board columns | string | Board columns | The accessible name of the column switcher, for other languages. |
| help-textdefault Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel. | string | Press Space to pick up the card. Use the Left and Right arrow keys to choose a column, then Space to drop it, or Escape to cancel. | The keyboard instructions for moving a card, read by screen readers, for other languages. |
| swipe-hint-textdefault Swipe sideways or tap a column | string | Swipe sideways or tap a column | The text of the phone line that swipe-hint shows, for other languages. |
| expand-labeldefault Expand {title} | string | Expand {title} | The accessible name of a folded column's toggle. {title} is the column's title, for other languages. |
| collapse-labeldefault Collapse {title} | string | Collapse {title} | The accessible name of an open column's toggle. {title} is the column's title, for other languages. |
| wui:kanban:movedefault - | event | - | Fires before a move is saved. It is cancelable. |
| wui:kanban:moveddefault - | event | - | Fires after a move is saved. |
| wui:kanban:faileddefault - | event | - | Fires when a move could not be saved. |
| wui:kanban:collapsedefault - | event | - | Fires when a collapsible column folds or opens. |
| wui:kanban:lockeddefault - | event | - | Fires when someone tries to pick up a card that cannot move. Its detail has the card key, the card and the reason, locked or readonly. |
| acceptdefault - | method | - | A hook property: return false, or a string saying why, to refuse a move. |
| setFilter(fn)default - | method | - | Shows only the cards fn returns true for. Pass null to clear it. |
| refresh()default - | method | - | Recounts the board after the page changes its cards itself. |
| moveCard(key, to)default - | method | - | Moves a card through the same rules and saving as a drag. |
| classdefault - | string | - | Extra classes on the board. |
Screen reader
3 notes- Every card is a focus stop. Space picks a card up, Left and Right choose a column, Space or Enter drops it, Escape cancels, and Up and Down move between cards.
- Each step is announced to screen readers, refusals included.
- The board is a region named by ariaLabel. Below md it shows one column at a time, with a column switcher above it.