- Name
service- Kind
- parameter
- Type
KanbanService- Requirement
- required
DocsAPI referenceHeadlesskanban
kanban headless API
The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.
@grassroot/ui-headless-core/kanban
Core connector and vanilla API
connectKanban
functiondeclare function connectKanban(service: KanbanService, scope: PartScope, options?: KanbanConnectOptions): KanbanApi;serviceKanbanServicescopePartScopeoptionsKanbanConnectOptionsreturnKanbanApi- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
KanbanConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
KanbanApi- Requirement
- n/a
createKanbanDragState
functionDuplicate of frozen `createKanbanDragState`.
declare function createKanbanDragState(): KanbanDragState;returnKanbanDragState- Name
return- Kind
- return value
- Type
KanbanDragState- Requirement
- n/a
EMPTY_KANBAN_PLACEMENTS
valueexport declare const EMPTY_KANBAN_PLACEMENTS: readonly KanbanPlacement[];kanbanAnatomy
valueexport declare const kanbanAnatomy: { readonly scope: "kanban"; readonly parts: readonly ["root", "column", "header", "card", "live"];};partsreadonly ["root", "column", "header", "card", "live"]scope"kanban"- Name
parts- Kind
- property
- Type
readonly ["root", "column", "header", "card", "live"]- Requirement
- required
- Name
scope- Kind
- property
- Type
"kanban"- Requirement
- required
KanbanAnnounceDetail
typetype KanbanAnnounceDetail = { readonly key: KanbanAnnounceKey; readonly cardId?: string; readonly columnId?: string; readonly fromColumnId?: string; readonly toColumnId?: string;};cardIdstringcolumnIdstringfromColumnIdstringkeyKanbanAnnounceKeytoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- optional
- Name
columnId- Kind
- property
- Type
string- Requirement
- optional
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- optional
- Name
key- Kind
- property
- Type
KanbanAnnounceKey- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- optional
KanbanAnnounceKey
typetype KanbanAnnounceKey = "kanban.grabbed" | "kanban.column" | "kanban.dropped" | "kanban.cancelled";KanbanApi
interfaceinterface KanbanApi { rootProps(): PartProps; columnProps(columnId: string, name?: string): PartProps; headerProps(columnId: string): PartProps; cardProps(cardId: string): PartProps; liveProps(): PartProps; move(cardId: string, toColumnId: string): void; selectAll(selectableIds?: SelectionValue): void; clear(): void; readonly placements: readonly KanbanPlacement[]; readonly dragStatus: KanbanDragStatus; readonly sourceCardId: string | null; readonly targetColumnId: string | null; readonly selectedIds: SelectionValue; readonly selectionMode: SelectionMode; readonly disableDrag: boolean; cardsInColumn(columnId: string): readonly KanbanPlacement[]; isOver(columnId: string): boolean; isDragging(cardId: string): boolean;}cardProps(cardId: string) => PartPropscardsInColumn(columnId: string) => readonly KanbanPlacement[]clear() => voidcolumnProps(columnId: string, name?: string) => PartPropsdisableDragbooleandragStatusKanbanDragStatusheaderProps(columnId: string) => PartPropsisDragging(cardId: string) => booleanisOver(columnId: string) => booleanliveProps() => PartPropsmove(cardId: string, toColumnId: string) => voidplacementsreadonly KanbanPlacement[]rootProps() => PartPropsselectAll(selectableIds?: SelectionValue) => void- Name
cardProps- Kind
- method
- Type
(cardId: string) => PartProps- Requirement
- required
- Name
cardsInColumn- Kind
- method
- Type
(columnId: string) => readonly KanbanPlacement[]- Requirement
- required
- Name
clear- Kind
- method
- Type
() => void- Requirement
- required
- Name
columnProps- Kind
- method
- Type
(columnId: string, name?: string) => PartProps- Requirement
- required
- Name
disableDrag- Kind
- property
- Type
boolean- Requirement
- required
- Name
dragStatus- Kind
- property
- Type
KanbanDragStatus- Requirement
- required
- Name
headerProps- Kind
- method
- Type
(columnId: string) => PartProps- Requirement
- required
- Name
isDragging- Kind
- method
- Type
(cardId: string) => boolean- Requirement
- required
- Name
isOver- Kind
- method
- Type
(columnId: string) => boolean- Requirement
- required
- Name
liveProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
move- Kind
- method
- Type
(cardId: string, toColumnId: string) => void- Requirement
- required
- Name
placements- Kind
- property
- Type
readonly KanbanPlacement[]- Requirement
- required
- Name
rootProps- Kind
- method
- Type
() => PartProps- Requirement
- required
- Name
selectAll- Kind
- method
- Type
(selectableIds?: SelectionValue) => void- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- required
- Name
selectionMode- Kind
- property
- Type
SelectionMode- Requirement
- required
- Name
sourceCardId- Kind
- property
- Type
string | null- Requirement
- required
- Name
targetColumnId- Kind
- property
- Type
string | null- Requirement
- required
KanbanCardSpec
interfaceinterface KanbanCardSpec extends KanbanPlacement { readonly title?: string;}titlestring- Name
title- Kind
- property
- Type
string- Requirement
- optional
KanbanColumnSpec
interfaceinterface KanbanColumnSpec { readonly id: string; readonly name: string;}idstringnamestring- Name
id- Kind
- property
- Type
string- Requirement
- required
- Name
name- Kind
- property
- Type
string- Requirement
- required
KanbanCommand
typetype KanbanCommand = KanbanMoveCommand | KanbanAnnounceCommand | SelectionCommand;KanbanConnectOptions
interfaceinterface KanbanConnectOptions { readonly onMove?: (detail: KanbanMoveDetail) => void; readonly onSelectedIdsChange?: (detail: SelectionChangeDetail) => void; readonly onAnnounce?: (detail: KanbanAnnounceDetail) => void; readonly columnNames?: Readonly<Record<string, string>>; readonly selectableIds?: SelectionValue;}columnNamesReadonly<Record<string, string>>onAnnounce(detail: KanbanAnnounceDetail) => voidonMove(detail: KanbanMoveDetail) => voidonSelectedIdsChange(detail: SelectionChangeDetail) => voidselectableIdsSelectionValue- Name
columnNames- Kind
- property
- Type
Readonly<Record<string, string>>- Requirement
- optional
- Name
onAnnounce- Kind
- property
- Type
(detail: KanbanAnnounceDetail) => void- Requirement
- optional
- Name
onMove- Kind
- property
- Type
(detail: KanbanMoveDetail) => void- Requirement
- optional
- Name
onSelectedIdsChange- Kind
- property
- Type
(detail: SelectionChangeDetail) => void- Requirement
- optional
- Name
selectableIds- Kind
- property
- Type
SelectionValue- Requirement
- optional
KanbanContext
typetype KanbanContext = { readonly mode: BindingMode; readonly placements: readonly KanbanPlacement[]; readonly dragStatus: KanbanDragStatus; readonly sourceCardId: string | null; readonly sourceColumnId: string | null; readonly targetColumnId: string | null; readonly selection: SelectionMachineState;};dragStatusKanbanDragStatusmodeBindingModeplacementsreadonly KanbanPlacement[]selectionSelectionMachineStatesourceCardIdstring | nullsourceColumnIdstring | nulltargetColumnIdstring | null- Name
dragStatus- Kind
- property
- Type
KanbanDragStatus- Requirement
- required
- Name
mode- Kind
- property
- Type
BindingMode- Requirement
- required
- Name
placements- Kind
- property
- Type
readonly KanbanPlacement[]- Requirement
- required
- Name
selection- Kind
- property
- Type
SelectionMachineState- Requirement
- required
- Name
sourceCardId- Kind
- property
- Type
string | null- Requirement
- required
- Name
sourceColumnId- Kind
- property
- Type
string | null- Requirement
- required
- Name
targetColumnId- Kind
- property
- Type
string | null- Requirement
- required
KanbanDragStatus
typetype KanbanDragStatus = "idle" | "grabbed" | "dragging";KanbanEvent
typetype KanbanEvent = { readonly type: "POINTER_DRAG_START"; readonly cardId: string;} | { readonly type: "POINTER_DRAG_OVER"; readonly columnId: string;} | { readonly type: "POINTER_DRAG_LEAVE"; readonly columnId: string;} | { readonly type: "POINTER_DROP"; readonly columnId: string; readonly reason: KanbanMoveReason;} | { readonly type: "POINTER_DRAG_END";} | { readonly type: "KEYBOARD_GRAB"; readonly cardId: string;} | { readonly type: "KEYBOARD_MOVE"; readonly toColumnId: string;} | { readonly type: "KEYBOARD_DROP"; readonly reason: "keyboard";} | { readonly type: "KEYBOARD_CANCEL";} | { readonly type: "MOVE"; readonly cardId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;} | SelectionEvent;KanbanInput
typetype KanbanInput = { readonly cards?: readonly KanbanPlacement[]; readonly defaultCards?: readonly KanbanPlacement[]; readonly columnIds?: readonly string[]; readonly disableDrag?: boolean; readonly selectionMode?: SelectionMode; readonly selectedIds?: SelectionValue; readonly defaultSelectedIds?: SelectionValue; readonly orderedIds?: readonly string[]; readonly disabledIds?: readonly string[];};cardsreadonly KanbanPlacement[]columnIdsreadonly string[]defaultCardsreadonly KanbanPlacement[]defaultSelectedIdsSelectionValuedisabledIdsreadonly string[]disableDragbooleanorderedIdsreadonly string[]selectedIdsSelectionValueselectionModeSelectionMode- Name
cards- Kind
- property
- Type
readonly KanbanPlacement[]- Requirement
- optional
- Name
columnIds- Kind
- property
- Type
readonly string[]- Requirement
- optional
- Name
defaultCards- Kind
- property
- Type
readonly KanbanPlacement[]- Requirement
- optional
- Name
defaultSelectedIds- Kind
- property
- Type
SelectionValue- Requirement
- optional
- Name
disabledIds- Kind
- property
- Type
readonly string[]- Requirement
- optional
- Name
disableDrag- Kind
- property
- Type
boolean- Requirement
- optional
- Name
orderedIds- Kind
- property
- Type
readonly string[]- Requirement
- optional
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- optional
- Name
selectionMode- Kind
- property
- Type
SelectionMode- Requirement
- optional
kanbanMachine
valueexport declare const kanbanMachine: KanbanMachine;KanbanMount
interfaceinterface KanbanMount { readonly service: KanbanService; readonly connector: KanbanApi; readonly root: HTMLElement; destroy(): void;}connectorKanbanApidestroy() => voidrootHTMLElementserviceKanbanService- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
destroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
root- Kind
- property
- Type
HTMLElement- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
KanbanMoveDetail
typetype KanbanMoveDetail = { readonly cardId: string; readonly fromColumnId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;};cardIdstringfromColumnIdstringreasonKanbanMoveReasontoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
KanbanMoveReason- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- required
KanbanMoveReason
typetype KanbanMoveReason = "pointer" | "keyboard" | "programmatic";KanbanPart
typetype KanbanPart = (typeof kanbanAnatomy.parts)[number];KanbanPlacement
typetype KanbanPlacement = { readonly cardId: string; readonly columnId: string;};cardIdstringcolumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
columnId- Kind
- property
- Type
string- Requirement
- required
kanbanSelectors
valueexport declare const kanbanSelectors: { mode: (snapshot: KanbanSnapshot) => BindingMode; placements: (snapshot: KanbanSnapshot) => readonly KanbanPlacement[]; dragStatus: (snapshot: KanbanSnapshot) => KanbanDragStatus; sourceCardId: (snapshot: KanbanSnapshot) => string | null; sourceColumnId: (snapshot: KanbanSnapshot) => string | null; targetColumnId: (snapshot: KanbanSnapshot) => string | null; draggingId: (snapshot: KanbanSnapshot) => string | null; overColumn: (snapshot: KanbanSnapshot) => string | null; selectedIds: (snapshot: KanbanSnapshot) => SelectionValue; selection: (snapshot: KanbanSnapshot) => SelectionMachineState; cardsInColumn: (snapshot: KanbanSnapshot, columnId: string) => readonly KanbanPlacement[];};cardsInColumn(snapshot: KanbanSnapshot, columnId: string) => readonly KanbanPlacement[]draggingId(snapshot: KanbanSnapshot) => string | nulldragStatus(snapshot: KanbanSnapshot) => KanbanDragStatusmode(snapshot: KanbanSnapshot) => BindingModeoverColumn(snapshot: KanbanSnapshot) => string | nullplacements(snapshot: KanbanSnapshot) => readonly KanbanPlacement[]selectedIds(snapshot: KanbanSnapshot) => SelectionValueselection(snapshot: KanbanSnapshot) => SelectionMachineStatesourceCardId(snapshot: KanbanSnapshot) => string | nullsourceColumnId(snapshot: KanbanSnapshot) => string | nulltargetColumnId(snapshot: KanbanSnapshot) => string | null- Name
cardsInColumn- Kind
- property
- Type
(snapshot: KanbanSnapshot, columnId: string) => readonly KanbanPlacement[]- Requirement
- required
- Name
draggingId- Kind
- property
- Type
(snapshot: KanbanSnapshot) => string | null- Requirement
- required
- Name
dragStatus- Kind
- property
- Type
(snapshot: KanbanSnapshot) => KanbanDragStatus- Requirement
- required
- Name
mode- Kind
- property
- Type
(snapshot: KanbanSnapshot) => BindingMode- Requirement
- required
- Name
overColumn- Kind
- property
- Type
(snapshot: KanbanSnapshot) => string | null- Requirement
- required
- Name
placements- Kind
- property
- Type
(snapshot: KanbanSnapshot) => readonly KanbanPlacement[]- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
(snapshot: KanbanSnapshot) => SelectionValue- Requirement
- required
- Name
selection- Kind
- property
- Type
(snapshot: KanbanSnapshot) => SelectionMachineState- Requirement
- required
- Name
sourceCardId- Kind
- property
- Type
(snapshot: KanbanSnapshot) => string | null- Requirement
- required
- Name
sourceColumnId- Kind
- property
- Type
(snapshot: KanbanSnapshot) => string | null- Requirement
- required
- Name
targetColumnId- Kind
- property
- Type
(snapshot: KanbanSnapshot) => string | null- Requirement
- required
KanbanService
typetype KanbanService = Service<KanbanInput, KanbanStateValue, KanbanContext, KanbanEvent, KanbanCommand>;KanbanSnapshot
typetype KanbanSnapshot = Snapshot<KanbanStateValue, KanbanContext>;KanbanStateValue
typetype KanbanStateValue = "active";mountKanban
functiondeclare function mountKanban(container: HTMLElement, options: MountKanbanOptions): KanbanMount;containerHTMLElementoptionsMountKanbanOptionsreturnKanbanMount- Name
container- Kind
- parameter
- Type
HTMLElement- Requirement
- required
- Name
options- Kind
- parameter
- Type
MountKanbanOptions- Requirement
- required
- Name
return- Kind
- return value
- Type
KanbanMount- Requirement
- n/a
MountKanbanOptions
interfaceinterface MountKanbanOptions extends Omit<KanbanInput, "columnIds" | "cards" | "defaultCards"> { readonly columns: readonly KanbanColumnSpec[]; readonly cards?: readonly KanbanCardSpec[]; readonly defaultCards?: readonly KanbanCardSpec[]; readonly onMove?: (detail: KanbanMoveDetail) => void; readonly onAnnounce?: (detail: KanbanAnnounceDetail) => void; readonly renderCard?: (card: HTMLElement, spec: KanbanCardSpec, placement: KanbanPlacement) => void;}cardsreadonly KanbanCardSpec[]columnsreadonly KanbanColumnSpec[]defaultCardsreadonly KanbanCardSpec[]onAnnounce(detail: KanbanAnnounceDetail) => voidonMove(detail: KanbanMoveDetail) => voidrenderCard(card: HTMLElement, spec: KanbanCardSpec, placement: KanbanPlacement) => void- Name
cards- Kind
- property
- Type
readonly KanbanCardSpec[]- Requirement
- optional
- Name
columns- Kind
- property
- Type
readonly KanbanColumnSpec[]- Requirement
- required
- Name
defaultCards- Kind
- property
- Type
readonly KanbanCardSpec[]- Requirement
- optional
- Name
onAnnounce- Kind
- property
- Type
(detail: KanbanAnnounceDetail) => void- Requirement
- optional
- Name
onMove- Kind
- property
- Type
(detail: KanbanMoveDetail) => void- Requirement
- optional
- Name
renderCard- Kind
- property
- Type
(card: HTMLElement, spec: KanbanCardSpec, placement: KanbanPlacement) => void- Requirement
- optional
moveKanbanPlacement
functionDuplicate of frozen `moveCard` over placements (cardId, not full card objects).
declare function moveKanbanPlacement(placements: readonly KanbanPlacement[], cardId: string, toColumnId: string): readonly KanbanPlacement[];placementsreadonly KanbanPlacement[]cardIdstringtoColumnIdstringreturnreadonly KanbanPlacement[]- Name
placements- Kind
- parameter
- Type
readonly KanbanPlacement[]- Requirement
- required
- Name
cardId- Kind
- parameter
- Type
string- Requirement
- required
- Name
toColumnId- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
readonly KanbanPlacement[]- Requirement
- n/a
placementsByColumn
functionDuplicate of frozen `cardsByColumn`.
declare function placementsByColumn(placements: readonly KanbanPlacement[], columnId: string): readonly KanbanPlacement[];placementsreadonly KanbanPlacement[]columnIdstringreturnreadonly KanbanPlacement[]- Name
placements- Kind
- parameter
- Type
readonly KanbanPlacement[]- Requirement
- required
- Name
columnId- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
readonly KanbanPlacement[]- Requirement
- n/a
projectKanbanPlacements
functiondeclare function projectKanbanPlacements(cards: readonly { readonly id: string; readonly columnId: string;}[]): readonly KanbanPlacement[];cardsreadonly {
readonly id: string;
readonly columnId: string;
}[]returnreadonly KanbanPlacement[]- Name
cards- Kind
- parameter
- Type
readonly { readonly id: string; readonly columnId: string; }[]- Requirement
- required
- Name
return- Kind
- return value
- Type
readonly KanbanPlacement[]- Requirement
- n/a
reduceKanbanDrag
functionDuplicate of frozen `reduceKanbanDrag`.
declare function reduceKanbanDrag(state: KanbanDragState, action: KanbanDragAction): KanbanDragState;stateKanbanDragStateactionKanbanDragActionreturnKanbanDragState- Name
state- Kind
- parameter
- Type
KanbanDragState- Requirement
- required
- Name
action- Kind
- parameter
- Type
KanbanDragAction- Requirement
- required
- Name
return- Kind
- return value
- Type
KanbanDragState- Requirement
- n/a
runKanbanCommand
functiondeclare function runKanbanCommand(command: KanbanCommand, scope: PartScope, options?: KanbanConnectOptions): void;commandKanbanCommandscopePartScopeoptionsKanbanConnectOptionsreturnvoid- Name
command- Kind
- parameter
- Type
KanbanCommand- Requirement
- required
- Name
scope- Kind
- parameter
- Type
PartScope- Requirement
- required
- Name
options- Kind
- parameter
- Type
KanbanConnectOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
void- Requirement
- n/a
selectionInputFromKanban
functiondeclare function selectionInputFromKanban(input: KanbanInput): SelectionInput;inputKanbanInputreturnSelectionInput- Name
input- Kind
- parameter
- Type
KanbanInput- Requirement
- required
- Name
return- Kind
- return value
- Type
SelectionInput- Requirement
- n/a
Framework adapters
Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.
React imports
import { Card, Column, Header, Kanban, Live, Root } from "@grassroot/ui-headless-react/kanban";Vue imports
<script setup lang="ts">import { KanbanCard, KanbanColumn, KanbanHeader, KanbanLive, KanbanRoot } from "@grassroot/ui-headless-vue/kanban";</script>Angular imports
import { Component } from "@angular/core";import { GR_KANBAN_DECLARATIONS } from "@grassroot/ui-headless-angular/kanban"; @Component({ standalone: true, imports: [GR_KANBAN_DECLARATIONS], template: `<!-- compose the kanban parts here -->` })export class Example {}Svelte imports
<script lang="ts"> import { KanbanCard, KanbanColumn, KanbanHeader, KanbanLive, KanbanRoot } from "@grassroot/ui-headless-svelte/kanban";</script>Solid imports
import { KanbanCard, KanbanColumn, KanbanHeader, KanbanLive, KanbanRoot } from "@grassroot/ui-headless-solid/kanban";@grassroot/ui-headless-react/kanban
React adapter
Card
valueexport declare const Card: import("react").ForwardRefExoticComponent<KanbanCardProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Column
valueexport declare const Column: import("react").ForwardRefExoticComponent<KanbanColumnProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Header
valueexport declare const Header: import("react").ForwardRefExoticComponent<KanbanHeaderProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Kanban
valueexport declare const Kanban: { Root: import("react").ForwardRefExoticComponent<KanbanRootProps & import("react").RefAttributes<HTMLDivElement>>; Column: import("react").ForwardRefExoticComponent<KanbanColumnProps & import("react").RefAttributes<HTMLDivElement>>; Header: import("react").ForwardRefExoticComponent<KanbanHeaderProps & import("react").RefAttributes<HTMLDivElement>>; Card: import("react").ForwardRefExoticComponent<KanbanCardProps & import("react").RefAttributes<HTMLDivElement>>; Live: import("react").ForwardRefExoticComponent<KanbanLiveProps & import("react").RefAttributes<HTMLDivElement>>;};Cardimport("react").ForwardRefExoticComponent<KanbanCardProps & import("react").RefAttributes<HTMLDivElement>>Columnimport("react").ForwardRefExoticComponent<KanbanColumnProps & import("react").RefAttributes<HTMLDivElement>>Headerimport("react").ForwardRefExoticComponent<KanbanHeaderProps & import("react").RefAttributes<HTMLDivElement>>Liveimport("react").ForwardRefExoticComponent<KanbanLiveProps & import("react").RefAttributes<HTMLDivElement>>Rootimport("react").ForwardRefExoticComponent<KanbanRootProps & import("react").RefAttributes<HTMLDivElement>>- Name
Card- Kind
- property
- Type
import("react").ForwardRefExoticComponent<KanbanCardProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Column- Kind
- property
- Type
import("react").ForwardRefExoticComponent<KanbanColumnProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Header- Kind
- property
- Type
import("react").ForwardRefExoticComponent<KanbanHeaderProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Live- Kind
- property
- Type
import("react").ForwardRefExoticComponent<KanbanLiveProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
- Name
Root- Kind
- property
- Type
import("react").ForwardRefExoticComponent<KanbanRootProps & import("react").RefAttributes<HTMLDivElement>>- Requirement
- required
KanbanCardProps
interfaceinterface KanbanCardProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly cardId: string; readonly children?: ReactNode;}asChildbooleancardIdstringchildrenReactNode- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
KanbanColumnProps
interfaceinterface KanbanColumnProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly columnId: string; readonly name?: string; readonly children?: ReactNode;}asChildbooleanchildrenReactNodecolumnIdstringnamestring- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
columnId- Kind
- property
- Type
string- Requirement
- required
- Name
name- Kind
- property
- Type
string- Requirement
- optional
KanbanContext
valueexport declare const KanbanContext: import("react").Context<KanbanContextValue | null>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
KanbanContextValue
interfaceinterface KanbanContextValue { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope;}connectorKanbanApiscopePartScopeserviceKanbanService- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
KanbanHeaderProps
interfaceinterface KanbanHeaderProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly columnId: string; readonly children?: ReactNode;}asChildbooleanchildrenReactNodecolumnIdstring- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
columnId- Kind
- property
- Type
string- Requirement
- required
KanbanLiveProps
interfaceinterface KanbanLiveProps extends ComponentPropsWithoutRef<"div"> { readonly asChild?: boolean; readonly children?: ReactNode;}asChildbooleanchildrenReactNode- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
KanbanMoveDetail
typetype KanbanMoveDetail = { readonly cardId: string; readonly fromColumnId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;};cardIdstringfromColumnIdstringreasonKanbanMoveReasontoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
KanbanMoveReason- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- required
KanbanRootProps
interfaceinterface KanbanRootProps extends Omit<ComponentPropsWithoutRef<"div">, "onChange"> { readonly asChild?: boolean; readonly cards?: KanbanInput["cards"]; readonly defaultCards?: KanbanInput["defaultCards"]; readonly columnIds?: KanbanInput["columnIds"]; readonly disableDrag?: KanbanInput["disableDrag"]; readonly selectionMode?: KanbanInput["selectionMode"]; readonly selectedIds?: KanbanInput["selectedIds"]; readonly defaultSelectedIds?: KanbanInput["defaultSelectedIds"]; readonly orderedIds?: KanbanInput["orderedIds"]; readonly disabledIds?: KanbanInput["disabledIds"]; readonly onMove?: (detail: KanbanMoveDetail) => void; readonly onSelectedIdsChange?: (detail: SelectionChangeDetail) => void; readonly children?: ReactNode;}asChildbooleancardsKanbanInput["cards"]childrenReactNodecolumnIdsKanbanInput["columnIds"]defaultCardsKanbanInput["defaultCards"]defaultSelectedIdsKanbanInput["defaultSelectedIds"]disabledIdsKanbanInput["disabledIds"]disableDragKanbanInput["disableDrag"]onMove(detail: KanbanMoveDetail) => voidonSelectedIdsChange(detail: SelectionChangeDetail) => voidorderedIdsKanbanInput["orderedIds"]selectedIdsKanbanInput["selectedIds"]selectionModeKanbanInput["selectionMode"]- Name
asChild- Kind
- property
- Type
boolean- Requirement
- optional
- Name
cards- Kind
- property
- Type
KanbanInput["cards"]- Requirement
- optional
- Name
children- Kind
- property
- Type
ReactNode- Requirement
- optional
- Name
columnIds- Kind
- property
- Type
KanbanInput["columnIds"]- Requirement
- optional
- Name
defaultCards- Kind
- property
- Type
KanbanInput["defaultCards"]- Requirement
- optional
- Name
defaultSelectedIds- Kind
- property
- Type
KanbanInput["defaultSelectedIds"]- Requirement
- optional
- Name
disabledIds- Kind
- property
- Type
KanbanInput["disabledIds"]- Requirement
- optional
- Name
disableDrag- Kind
- property
- Type
KanbanInput["disableDrag"]- Requirement
- optional
- Name
onMove- Kind
- property
- Type
(detail: KanbanMoveDetail) => void- Requirement
- optional
- Name
onSelectedIdsChange- Kind
- property
- Type
(detail: SelectionChangeDetail) => void- Requirement
- optional
- Name
orderedIds- Kind
- property
- Type
KanbanInput["orderedIds"]- Requirement
- optional
- Name
selectedIds- Kind
- property
- Type
KanbanInput["selectedIds"]- Requirement
- optional
- Name
selectionMode- Kind
- property
- Type
KanbanInput["selectionMode"]- Requirement
- optional
Live
valueexport declare const Live: import("react").ForwardRefExoticComponent<KanbanLiveProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
Root
valueexport declare const Root: import("react").ForwardRefExoticComponent<KanbanRootProps & import("react").RefAttributes<HTMLDivElement>>;propsPreturnReactNode- Name
props- Kind
- parameter
- Type
P- Requirement
- required
- Name
return- Kind
- return value
- Type
ReactNode- Requirement
- n/a
type SelectionChangeDetail = { readonly selectedIds: SelectionValue; readonly reason: SelectionChangeReason;};reasonSelectionChangeReasonselectedIdsSelectionValue- Name
reason- Kind
- property
- Type
SelectionChangeReason- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- required
useKanban
functiondeclare function useKanban(input: KanbanInput, options?: UseKanbanOptions): UseKanbanResult;inputKanbanInputoptionsUseKanbanOptionsreturnUseKanbanResult- Name
input- Kind
- parameter
- Type
KanbanInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseKanbanOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseKanbanResult- Requirement
- n/a
useKanbanContext
functiondeclare function useKanbanContext(partName: string): KanbanContextValue;partNamestringreturnKanbanContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
KanbanContextValue- Requirement
- n/a
UseKanbanOptions
interfaceinterface UseKanbanOptions extends KanbanConnectOptions {}UseKanbanResult
interfaceinterface UseKanbanResult { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly snapshot: KanbanSnapshot;}connectorKanbanApiscopePartScopeserviceKanbanServicesnapshotKanbanSnapshot- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
KanbanSnapshot- Requirement
- required
@grassroot/ui-headless-vue/kanban
Vue adapter
KanbanCard
valueexport declare const KanbanCard: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; cardId: { type: StringConstructor; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; cardId: { type: StringConstructor; required: true; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;KanbanColumn
valueexport declare const KanbanColumn: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; columnId: { type: StringConstructor; required: true; }; name: { type: StringConstructor; default: undefined; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; columnId: { type: StringConstructor; required: true; }; name: { type: StringConstructor; default: undefined; };}>> & Readonly<{}>, { asChild: boolean; name: string;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;KanbanContextKey
valueexport declare const KanbanContextKey: InjectionKey<KanbanContextValue>;KanbanContextValue
interfaceinterface KanbanContextValue { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly snapshot: ShallowRef<KanbanSnapshot>;}connectorKanbanApiscopePartScopeserviceKanbanServicesnapshotShallowRef<KanbanSnapshot>- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<KanbanSnapshot>- Requirement
- required
KanbanHeader
valueexport declare const KanbanHeader: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; columnId: { type: StringConstructor; required: true; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; columnId: { type: StringConstructor; required: true; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;KanbanLive
valueexport declare const KanbanLive: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; };}>> & Readonly<{}>, { asChild: boolean;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;KanbanMoveDetail
typetype KanbanMoveDetail = { readonly cardId: string; readonly fromColumnId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;};cardIdstringfromColumnIdstringreasonKanbanMoveReasontoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
KanbanMoveReason- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- required
KanbanRoot
valueexport declare const KanbanRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; cards: { type: PropType<KanbanInput["cards"]>; default: undefined; }; defaultCards: { type: PropType<KanbanInput["defaultCards"]>; default: undefined; }; columnIds: { type: PropType<KanbanInput["columnIds"]>; default: undefined; }; disableDrag: { type: PropType<boolean | undefined>; default: undefined; }; selectionMode: { type: PropType<KanbanInput["selectionMode"]>; default: undefined; }; selectedIds: { type: PropType<KanbanInput["selectedIds"]>; default: undefined; }; defaultSelectedIds: { type: PropType<KanbanInput["defaultSelectedIds"]>; default: undefined; }; orderedIds: { type: PropType<KanbanInput["orderedIds"]>; default: undefined; }; disabledIds: { type: PropType<KanbanInput["disabledIds"]>; default: undefined; };}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, { [key: string]: any;}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, { move: (_detail: KanbanMoveDetail) => true; selectedIdsChange: (_detail: SelectionChangeDetail) => true;}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{ asChild: { type: BooleanConstructor; default: boolean; }; cards: { type: PropType<KanbanInput["cards"]>; default: undefined; }; defaultCards: { type: PropType<KanbanInput["defaultCards"]>; default: undefined; }; columnIds: { type: PropType<KanbanInput["columnIds"]>; default: undefined; }; disableDrag: { type: PropType<boolean | undefined>; default: undefined; }; selectionMode: { type: PropType<KanbanInput["selectionMode"]>; default: undefined; }; selectedIds: { type: PropType<KanbanInput["selectedIds"]>; default: undefined; }; defaultSelectedIds: { type: PropType<KanbanInput["defaultSelectedIds"]>; default: undefined; }; orderedIds: { type: PropType<KanbanInput["orderedIds"]>; default: undefined; }; disabledIds: { type: PropType<KanbanInput["disabledIds"]>; default: undefined; };}>> & Readonly<{ onMove?: ((_detail: KanbanMoveDetail) => any) | undefined; onSelectedIdsChange?: ((_detail: SelectionChangeDetail) => any) | undefined;}>, { asChild: boolean; cards: readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined; defaultCards: readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined; columnIds: readonly string[] | undefined; disableDrag: boolean | undefined; selectionMode: import("@grassroot/ui-machines/selection").SelectionMode | undefined; selectedIds: import("@grassroot/ui-machines/selection").SelectionValue | undefined; defaultSelectedIds: import("@grassroot/ui-machines/selection").SelectionValue | undefined; orderedIds: readonly string[] | undefined; disabledIds: readonly string[] | undefined;}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;type SelectionChangeDetail = { readonly selectedIds: SelectionValue; readonly reason: SelectionChangeReason;};reasonSelectionChangeReasonselectedIdsSelectionValue- Name
reason- Kind
- property
- Type
SelectionChangeReason- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- required
useKanban
functiondeclare function useKanban(input: KanbanInput | (() => KanbanInput), options?: UseKanbanOptions): UseKanbanResult;inputKanbanInput | (() => KanbanInput)optionsUseKanbanOptionsreturnUseKanbanResult- Name
input- Kind
- parameter
- Type
KanbanInput | (() => KanbanInput)- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseKanbanOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseKanbanResult- Requirement
- n/a
useKanbanContext
functiondeclare function useKanbanContext(partName: string): KanbanContextValue;partNamestringreturnKanbanContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
KanbanContextValue- Requirement
- n/a
UseKanbanOptions
interfaceinterface UseKanbanOptions extends KanbanConnectOptions {}UseKanbanResult
interfaceinterface UseKanbanResult { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly snapshot: ShallowRef<KanbanSnapshot>;}connectorKanbanApiscopePartScopeserviceKanbanServicesnapshotShallowRef<KanbanSnapshot>- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
ShallowRef<KanbanSnapshot>- Requirement
- required
@grassroot/ui-headless-angular/kanban
Angular adapter
createKanbanStore
functionexport declare function createKanbanStore(initialInput: KanbanInput, options?: CreateKanbanStoreOptions): KanbanStore;initialInputKanbanInputoptionsCreateKanbanStoreOptionsreturnKanbanStore- Name
initialInput- Kind
- parameter
- Type
KanbanInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
CreateKanbanStoreOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
KanbanStore- Requirement
- n/a
CreateKanbanStoreOptions
interfaceexport interface CreateKanbanStoreOptions extends KanbanConnectOptions { readonly onCommit?: () => void;}onCommit() => void- Name
onCommit- Kind
- property
- Type
() => void- Requirement
- optional
GR_KANBAN_DECLARATIONS
valueexport declare const GR_KANBAN_DECLARATIONS: readonly [typeof GrKanbanRoot, typeof GrKanbanColumn, typeof GrKanbanHeader, typeof GrKanbanCard, typeof GrKanbanLive];GrKanbanCard
classexport declare class GrKanbanCard implements OnDestroy { readonly cardId: import("@angular/core").InputSignal<string>; private readonly store; private readonly elementRef; private readonly listeners; private readonly consumerProps; private registeredKey; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrKanbanCard, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrKanbanCard, "[grKanbanCard]", never, { "cardId": { "alias": "cardId"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}cardIdimport("@angular/core").InputSignal<string>consumerPropsanyelementRefanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrKanbanCard, "[grKanbanCard]", never, { "cardId": { "alias": "cardId"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrKanbanCard, never>registeredKeyanystoreany- Name
cardId- Kind
- property
- Type
import("@angular/core").InputSignal<string>- Requirement
- required
- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
elementRef- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrKanbanCard, "[grKanbanCard]", never, { "cardId": { "alias": "cardId"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrKanbanCard, never>- Requirement
- required
- Name
registeredKey- Kind
- property
- Type
any- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrKanbanColumn
classexport declare class GrKanbanColumn implements OnDestroy { readonly columnId: import("@angular/core").InputSignal<string>; readonly name: import("@angular/core").InputSignal<string | undefined>; private readonly store; private readonly elementRef; private readonly listeners; private readonly consumerProps; private registeredKey; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrKanbanColumn, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrKanbanColumn, "[grKanbanColumn]", never, { "columnId": { "alias": "columnId"; "required": true; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;}columnIdimport("@angular/core").InputSignal<string>consumerPropsanyelementRefanylistenersanynameimport("@angular/core").InputSignal<string | undefined>ngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrKanbanColumn, "[grKanbanColumn]", never, { "columnId": { "alias": "columnId"; "required": true; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrKanbanColumn, never>registeredKeyanystoreany- Name
columnId- Kind
- property
- Type
import("@angular/core").InputSignal<string>- Requirement
- required
- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
elementRef- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
name- Kind
- property
- Type
import("@angular/core").InputSignal<string | undefined>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrKanbanColumn, "[grKanbanColumn]", never, { "columnId": { "alias": "columnId"; "required": true; "isSignal": true; }; "name": { "alias": "name"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrKanbanColumn, never>- Requirement
- required
- Name
registeredKey- Kind
- property
- Type
any- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrKanbanHeader
classexport declare class GrKanbanHeader implements OnDestroy { readonly columnId: import("@angular/core").InputSignal<string>; private readonly store; private readonly elementRef; private readonly listeners; private readonly consumerProps; private registeredKey; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrKanbanHeader, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrKanbanHeader, "[grKanbanHeader]", never, { "columnId": { "alias": "columnId"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;}columnIdimport("@angular/core").InputSignal<string>consumerPropsanyelementRefanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrKanbanHeader, "[grKanbanHeader]", never, { "columnId": { "alias": "columnId"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrKanbanHeader, never>registeredKeyanystoreany- Name
columnId- Kind
- property
- Type
import("@angular/core").InputSignal<string>- Requirement
- required
- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
elementRef- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrKanbanHeader, "[grKanbanHeader]", never, { "columnId": { "alias": "columnId"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrKanbanHeader, never>- Requirement
- required
- Name
registeredKey- Kind
- property
- Type
any- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrKanbanLive
classexport declare class GrKanbanLive implements OnDestroy { private readonly store; private readonly elementRef; private readonly listeners; private readonly consumerProps; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrKanbanLive, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<GrKanbanLive, "[grKanbanLive]", never, {}, {}, never, never, true, never>;}consumerPropsanyelementRefanylistenersanyngOnDestroy() => voidɵdiri0.ɵɵDirectiveDeclaration<GrKanbanLive, "[grKanbanLive]", never, {}, {}, never, never, true, never>ɵfaci0.ɵɵFactoryDeclaration<GrKanbanLive, never>storeany- Name
consumerProps- Kind
- property
- Type
any- Requirement
- required
- Name
elementRef- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
ɵdir- Kind
- property
- Type
i0.ɵɵDirectiveDeclaration<GrKanbanLive, "[grKanbanLive]", never, {}, {}, never, never, true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrKanbanLive, never>- Requirement
- required
- Name
store- Kind
- property
- Type
any- Requirement
- required
GrKanbanRoot
classexport declare class GrKanbanRoot implements OnDestroy { readonly cards: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined>; readonly defaultCards: import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined>; readonly columnIds: import("@angular/core").InputSignal<readonly string[] | undefined>; readonly disableDrag: import("@angular/core").InputSignal<boolean | undefined>; readonly selectionMode: import("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionMode | undefined>; readonly selectedIds: import("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionValue | undefined>; readonly defaultSelectedIds: import("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionValue | undefined>; readonly orderedIds: import("@angular/core").InputSignal<readonly string[] | undefined>; readonly disabledIds: import("@angular/core").InputSignal<readonly string[] | undefined>; readonly move: import("@angular/core").OutputEmitterRef<KanbanMoveDetail>; readonly selectedIdsChange: import("@angular/core").OutputEmitterRef<SelectionChangeDetail>; private readonly elementRef; private readonly injector; private readonly listeners; private lastSynced; readonly store: KanbanStore; constructor(); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<GrKanbanRoot, never>; static ɵcmp: i0.ɵɵComponentDeclaration<GrKanbanRoot, "gr-kanban-root", never, { "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "defaultCards": { "alias": "defaultCards"; "required": false; "isSignal": true; }; "columnIds": { "alias": "columnIds"; "required": false; "isSignal": true; }; "disableDrag": { "alias": "disableDrag"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "selectedIds": { "alias": "selectedIds"; "required": false; "isSignal": true; }; "defaultSelectedIds": { "alias": "defaultSelectedIds"; "required": false; "isSignal": true; }; "orderedIds": { "alias": "orderedIds"; "required": false; "isSignal": true; }; "disabledIds": { "alias": "disabledIds"; "required": false; "isSignal": true; }; }, { "move": "move"; "selectedIdsChange": "selectedIdsChange"; }, never, ["*"], true, never>;}cardsimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined>columnIdsimport("@angular/core").InputSignal<readonly string[] | undefined>defaultCardsimport("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined>defaultSelectedIdsimport("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionValue | undefined>disabledIdsimport("@angular/core").InputSignal<readonly string[] | undefined>disableDragimport("@angular/core").InputSignal<boolean | undefined>elementRefanyinjectoranylastSyncedanylistenersanymoveimport("@angular/core").OutputEmitterRef<KanbanMoveDetail>ngOnDestroy() => voidorderedIdsimport("@angular/core").InputSignal<readonly string[] | undefined>ɵcmpi0.ɵɵComponentDeclaration<GrKanbanRoot, "gr-kanban-root", never, { "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "defaultCards": { "alias": "defaultCards"; "required": false; "isSignal": true; }; "columnIds": { "alias": "columnIds"; "required": false; "isSignal": true; }; "disableDrag": { "alias": "disableDrag"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "selectedIds": { "alias": "selectedIds"; "required": false; "isSignal": true; }; "defaultSelectedIds": { "alias": "defaultSelectedIds"; "required": false; "isSignal": true; }; "orderedIds": { "alias": "orderedIds"; "required": false; "isSignal": true; }; "disabledIds": { "alias": "disabledIds"; "required": false; "isSignal": true; }; }, { "move": "move"; "selectedIdsChange": "selectedIdsChange"; }, never, ["*"], true, never>- Name
cards- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined>- Requirement
- required
- Name
columnIds- Kind
- property
- Type
import("@angular/core").InputSignal<readonly string[] | undefined>- Requirement
- required
- Name
defaultCards- Kind
- property
- Type
import("@angular/core").InputSignal<readonly import("@grassroot/ui-machines/kanban").KanbanPlacement[] | undefined>- Requirement
- required
- Name
defaultSelectedIds- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionValue | undefined>- Requirement
- required
- Name
disabledIds- Kind
- property
- Type
import("@angular/core").InputSignal<readonly string[] | undefined>- Requirement
- required
- Name
disableDrag- Kind
- property
- Type
import("@angular/core").InputSignal<boolean | undefined>- Requirement
- required
- Name
elementRef- Kind
- property
- Type
any- Requirement
- required
- Name
injector- Kind
- property
- Type
any- Requirement
- required
- Name
lastSynced- Kind
- property
- Type
any- Requirement
- required
- Name
listeners- Kind
- property
- Type
any- Requirement
- required
- Name
move- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<KanbanMoveDetail>- Requirement
- required
- Name
ngOnDestroy- Kind
- method
- Type
() => void- Requirement
- required
- Name
orderedIds- Kind
- property
- Type
import("@angular/core").InputSignal<readonly string[] | undefined>- Requirement
- required
- Name
ɵcmp- Kind
- property
- Type
i0.ɵɵComponentDeclaration<GrKanbanRoot, "gr-kanban-root", never, { "cards": { "alias": "cards"; "required": false; "isSignal": true; }; "defaultCards": { "alias": "defaultCards"; "required": false; "isSignal": true; }; "columnIds": { "alias": "columnIds"; "required": false; "isSignal": true; }; "disableDrag": { "alias": "disableDrag"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; "selectedIds": { "alias": "selectedIds"; "required": false; "isSignal": true; }; "defaultSelectedIds": { "alias": "defaultSelectedIds"; "required": false; "isSignal": true; }; "orderedIds": { "alias": "orderedIds"; "required": false; "isSignal": true; }; "disabledIds": { "alias": "disabledIds"; "required": false; "isSignal": true; }; }, { "move": "move"; "selectedIdsChange": "selectedIdsChange"; }, never, ["*"], true, never>- Requirement
- required
- Name
ɵfac- Kind
- property
- Type
i0.ɵɵFactoryDeclaration<GrKanbanRoot, never>- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionValue | undefined>- Requirement
- required
- Name
selectedIdsChange- Kind
- property
- Type
import("@angular/core").OutputEmitterRef<SelectionChangeDetail>- Requirement
- required
- Name
selectionMode- Kind
- property
- Type
import("@angular/core").InputSignal<import("@grassroot/ui-machines/selection").SelectionMode | undefined>- Requirement
- required
- Name
store- Kind
- property
- Type
KanbanStore- Requirement
- required
KANBAN_STORE
valueexport declare const KANBAN_STORE: InjectionToken<KanbanStore>;KanbanMoveDetail
typetype KanbanMoveDetail = { readonly cardId: string; readonly fromColumnId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;};cardIdstringfromColumnIdstringreasonKanbanMoveReasontoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
KanbanMoveReason- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- required
KanbanStore
interfaceexport interface KanbanStore { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly version: WritableSignal<number>; start(): void; stop(): void; sync(input: KanbanInput): void; bindMove(handler: (detail: KanbanMoveDetail) => void): void; bindSelectedIdsChange(handler: (detail: SelectionChangeDetail) => void): void;}bindMove(handler: (detail: KanbanMoveDetail) => void) => voidbindSelectedIdsChange(handler: (detail: SelectionChangeDetail) => void) => voidconnectorKanbanApiscopePartScopeserviceKanbanServicestart() => voidstop() => voidsync(input: KanbanInput) => voidversionWritableSignal<number>- Name
bindMove- Kind
- method
- Type
(handler: (detail: KanbanMoveDetail) => void) => void- Requirement
- required
- Name
bindSelectedIdsChange- Kind
- method
- Type
(handler: (detail: SelectionChangeDetail) => void) => void- Requirement
- required
- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
start- Kind
- method
- Type
() => void- Requirement
- required
- Name
stop- Kind
- method
- Type
() => void- Requirement
- required
- Name
sync- Kind
- method
- Type
(input: KanbanInput) => void- Requirement
- required
- Name
version- Kind
- property
- Type
WritableSignal<number>- Requirement
- required
provideKanbanStore
functionexport declare function provideKanbanStore(): Provider;returnProvider- Name
return- Kind
- return value
- Type
Provider- Requirement
- n/a
type SelectionChangeDetail = { readonly selectedIds: SelectionValue; readonly reason: SelectionChangeReason;};reasonSelectionChangeReasonselectedIdsSelectionValue- Name
reason- Kind
- property
- Type
SelectionChangeReason- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- required
@grassroot/ui-headless-svelte/kanban
Svelte adapter
createKanban
functionexport declare function createKanban(inputGetter: () => KanbanInput, options?: UseKanbanOptions): UseKanbanResult;inputGetter() => KanbanInputoptionsUseKanbanOptionsreturnUseKanbanResult- Name
inputGetter- Kind
- parameter
- Type
() => KanbanInput- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseKanbanOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseKanbanResult- Requirement
- n/a
KanbanCard
valueexport declare const KanbanCard: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
KanbanColumn
valueexport declare const KanbanColumn: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
KanbanContextValue
interfaceexport interface KanbanContextValue { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly version: () => number;}connectorKanbanApiscopePartScopeserviceKanbanServiceversion() => number- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
KanbanHeader
valueexport declare const KanbanHeader: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
KanbanLive
valueexport declare const KanbanLive: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
KanbanMoveDetail
typetype KanbanMoveDetail = { readonly cardId: string; readonly fromColumnId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;};cardIdstringfromColumnIdstringreasonKanbanMoveReasontoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
KanbanMoveReason- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- required
KanbanRoot
valueexport declare const KanbanRoot: LegacyComponentType;argsParameters<Component<Record<string, any>>>returnReturnType<Component<Record<string, any>, Record<string, any>>>- Name
args- Kind
- parameter
- Type
Parameters<Component<Record<string, any>>>- Requirement
- optional
- Name
return- Kind
- return value
- Type
ReturnType<Component<Record<string, any>, Record<string, any>>>- Requirement
- n/a
type SelectionChangeDetail = { readonly selectedIds: SelectionValue; readonly reason: SelectionChangeReason;};reasonSelectionChangeReasonselectedIdsSelectionValue- Name
reason- Kind
- property
- Type
SelectionChangeReason- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- required
useKanbanContext
functionexport declare function useKanbanContext(partName: string): KanbanContextValue;partNamestringreturnKanbanContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
KanbanContextValue- Requirement
- n/a
UseKanbanOptions
interfaceexport interface UseKanbanOptions extends KanbanConnectOptions {}UseKanbanResult
interfaceexport interface UseKanbanResult { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly version: () => number;}connectorKanbanApiscopePartScopeserviceKanbanServiceversion() => number- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
version- Kind
- property
- Type
() => number- Requirement
- required
@grassroot/ui-headless-solid/kanban
Solid adapter
KanbanCard
functionexport declare function KanbanCard(props: KanbanCardProps): JSX.Element;propsKanbanCardPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
KanbanCardProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
KanbanCardProps
interfaceexport interface KanbanCardProps extends JSX.HTMLAttributes<HTMLDivElement> { readonly as?: AsProp; readonly cardId: string;}asAsPropcardIdstring- Name
as- Kind
- property
- Type
AsProp- Requirement
- optional
- Name
cardId- Kind
- property
- Type
string- Requirement
- required
KanbanColumn
functionexport declare function KanbanColumn(props: KanbanColumnProps): JSX.Element;propsKanbanColumnPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
KanbanColumnProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
KanbanColumnProps
interfaceexport interface KanbanColumnProps extends JSX.HTMLAttributes<HTMLDivElement> { readonly as?: AsProp; readonly columnId: string; readonly name?: string;}asAsPropcolumnIdstringnamestring- Name
as- Kind
- property
- Type
AsProp- Requirement
- optional
- Name
columnId- Kind
- property
- Type
string- Requirement
- required
- Name
name- Kind
- property
- Type
string- Requirement
- optional
KanbanContext
valueexport declare const KanbanContext: import("solid-js").Context<KanbanContextValue | undefined>;KanbanContextValue
interfaceexport interface KanbanContextValue { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly snapshot: Accessor<KanbanSnapshot>;}connectorKanbanApiscopePartScopeserviceKanbanServicesnapshotAccessor<KanbanSnapshot>- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<KanbanSnapshot>- Requirement
- required
KanbanHeader
functionexport declare function KanbanHeader(props: KanbanHeaderProps): JSX.Element;propsKanbanHeaderPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
KanbanHeaderProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
KanbanHeaderProps
interfaceexport interface KanbanHeaderProps extends JSX.HTMLAttributes<HTMLDivElement> { readonly as?: AsProp; readonly columnId: string;}asAsPropcolumnIdstring- Name
as- Kind
- property
- Type
AsProp- Requirement
- optional
- Name
columnId- Kind
- property
- Type
string- Requirement
- required
KanbanLive
functionexport declare function KanbanLive(props: KanbanLiveProps): JSX.Element;propsKanbanLivePropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
KanbanLiveProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
KanbanLiveProps
interfaceexport interface KanbanLiveProps extends JSX.HTMLAttributes<HTMLDivElement> { readonly as?: AsProp;}asAsProp- Name
as- Kind
- property
- Type
AsProp- Requirement
- optional
KanbanMoveDetail
typetype KanbanMoveDetail = { readonly cardId: string; readonly fromColumnId: string; readonly toColumnId: string; readonly reason: KanbanMoveReason;};cardIdstringfromColumnIdstringreasonKanbanMoveReasontoColumnIdstring- Name
cardId- Kind
- property
- Type
string- Requirement
- required
- Name
fromColumnId- Kind
- property
- Type
string- Requirement
- required
- Name
reason- Kind
- property
- Type
KanbanMoveReason- Requirement
- required
- Name
toColumnId- Kind
- property
- Type
string- Requirement
- required
KanbanRoot
functionexport declare function KanbanRoot(props: KanbanRootProps): JSX.Element;propsKanbanRootPropsreturnJSX.Element- Name
props- Kind
- parameter
- Type
KanbanRootProps- Requirement
- required
- Name
return- Kind
- return value
- Type
JSX.Element- Requirement
- n/a
KanbanRootProps
interfaceexport interface KanbanRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> { readonly as?: AsProp; readonly cards?: KanbanInput["cards"]; readonly defaultCards?: KanbanInput["defaultCards"]; readonly columnIds?: KanbanInput["columnIds"]; readonly disableDrag?: KanbanInput["disableDrag"]; readonly selectionMode?: KanbanInput["selectionMode"]; readonly selectedIds?: KanbanInput["selectedIds"]; readonly defaultSelectedIds?: KanbanInput["defaultSelectedIds"]; readonly orderedIds?: KanbanInput["orderedIds"]; readonly disabledIds?: KanbanInput["disabledIds"]; readonly onMove?: (detail: KanbanMoveDetail) => void; readonly onSelectedIdsChange?: (detail: SelectionChangeDetail) => void;}asAsPropcardsKanbanInput["cards"]columnIdsKanbanInput["columnIds"]defaultCardsKanbanInput["defaultCards"]defaultSelectedIdsKanbanInput["defaultSelectedIds"]disabledIdsKanbanInput["disabledIds"]disableDragKanbanInput["disableDrag"]onMove(detail: KanbanMoveDetail) => voidonSelectedIdsChange(detail: SelectionChangeDetail) => voidorderedIdsKanbanInput["orderedIds"]selectedIdsKanbanInput["selectedIds"]selectionModeKanbanInput["selectionMode"]- Name
as- Kind
- property
- Type
AsProp- Requirement
- optional
- Name
cards- Kind
- property
- Type
KanbanInput["cards"]- Requirement
- optional
- Name
columnIds- Kind
- property
- Type
KanbanInput["columnIds"]- Requirement
- optional
- Name
defaultCards- Kind
- property
- Type
KanbanInput["defaultCards"]- Requirement
- optional
- Name
defaultSelectedIds- Kind
- property
- Type
KanbanInput["defaultSelectedIds"]- Requirement
- optional
- Name
disabledIds- Kind
- property
- Type
KanbanInput["disabledIds"]- Requirement
- optional
- Name
disableDrag- Kind
- property
- Type
KanbanInput["disableDrag"]- Requirement
- optional
- Name
onMove- Kind
- property
- Type
(detail: KanbanMoveDetail) => void- Requirement
- optional
- Name
onSelectedIdsChange- Kind
- property
- Type
(detail: SelectionChangeDetail) => void- Requirement
- optional
- Name
orderedIds- Kind
- property
- Type
KanbanInput["orderedIds"]- Requirement
- optional
- Name
selectedIds- Kind
- property
- Type
KanbanInput["selectedIds"]- Requirement
- optional
- Name
selectionMode- Kind
- property
- Type
KanbanInput["selectionMode"]- Requirement
- optional
type SelectionChangeDetail = { readonly selectedIds: SelectionValue; readonly reason: SelectionChangeReason;};reasonSelectionChangeReasonselectedIdsSelectionValue- Name
reason- Kind
- property
- Type
SelectionChangeReason- Requirement
- required
- Name
selectedIds- Kind
- property
- Type
SelectionValue- Requirement
- required
useKanban
functionexport declare function useKanban(input: Accessor<KanbanInput>, options?: UseKanbanOptions): UseKanbanResult;inputAccessor<KanbanInput>optionsUseKanbanOptionsreturnUseKanbanResult- Name
input- Kind
- parameter
- Type
Accessor<KanbanInput>- Requirement
- required
- Name
options- Kind
- parameter
- Type
UseKanbanOptions- Requirement
- optional
- Name
return- Kind
- return value
- Type
UseKanbanResult- Requirement
- n/a
useKanbanContext
functionexport declare function useKanbanContext(partName: string): KanbanContextValue;partNamestringreturnKanbanContextValue- Name
partName- Kind
- parameter
- Type
string- Requirement
- required
- Name
return- Kind
- return value
- Type
KanbanContextValue- Requirement
- n/a
UseKanbanOptions
interfaceexport interface UseKanbanOptions extends KanbanConnectOptions {}UseKanbanResult
interfaceexport interface UseKanbanResult { readonly service: KanbanService; readonly connector: KanbanApi; readonly scope: PartScope; readonly snapshot: Accessor<KanbanSnapshot>;}connectorKanbanApiscopePartScopeserviceKanbanServicesnapshotAccessor<KanbanSnapshot>- Name
connector- Kind
- property
- Type
KanbanApi- Requirement
- required
- Name
scope- Kind
- property
- Type
PartScope- Requirement
- required
- Name
service- Kind
- property
- Type
KanbanService- Requirement
- required
- Name
snapshot- Kind
- property
- Type
Accessor<KanbanSnapshot>- Requirement
- required