Skip to main content
Vuetify0 is now in alpha!
Vuetify0 Logo
Theme
Mode
Palettes
Accessibility
Vuetify One
Sign in to Vuetify One

Access premium tools across the Vuetify ecosystem — Bin, Play, Studio, and more.

Not a subscriber? See what's included

createKanban API

API reference for the createKanban composable.

Explore these related pages for additional context and usage patterns.

PageCategory
createKanbanData
createSortableData
useDragDropSystem
createRegistryRegistration

Functions

createKanban

(_options?: KanbanOptions) => KanbanContext<ItemZ, ColZ>

Create a headless two-level sortable orchestrator.

Options

reactive

boolean | undefined

Enable reactive behavior for registry operations

Default: false

disabled

MaybeRefOrGetter<boolean> | undefined

Disabled state for the entire model instance

Default: false

enroll

MaybeRefOrGetter<boolean> | undefined

Auto-select tickets on registration

Default: true

multiple

MaybeRefOrGetter<boolean> | undefined

Allow multiple tickets to be selected simultaneously

Default: false

Properties

columns

SortableContext<ColZ, KanbanColumnTicket<ItemZ, ColZ>>

Column registry. Use this for column register / unregister / move / swap / reorder.

on

KanbanEventListener<ItemZ>

Subscribe to the kanban-level `transfer:ticket` event, fired after each successful cross-column move. Registry events (`register:ticket`, `unregister:ticket`, `move:ticket`) live on the columns registry — use `kanban.columns.on(...)` for those, or `column.items.on(...)` for per-column intra-column reorder events.

off

KanbanEventListener<ItemZ>

Unsubscribe from the `transfer:ticket` event. Must be called with the same callback reference used to subscribe.

Methods

transfer

(id: ID, toColumnId: ID, toIndex: number) => SortableTicket<ItemZ> | undefined

Move an item across columns. Same-column transfer (where `toColumnId` matches the item's current column) collapses to `column.items.move` and does not emit `transfer:ticket`. Returns the moved ticket, or `undefined` when gated (kanban / source / destination / item disabled, destination.accept rejected, unknown id, duplicate destination id).

Was this page helpful?

Ctrl+/