collection-kanban
collection-kanban
Interfaces
CollectionKanbanMove
Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:5
Type Parameters
| Type Parameter |
|---|
Row |
Properties
fromLane
fromLane: string;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:7
record
record: Row;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:6
toLane
toLane: string;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:8
CollectionKanbanProps
Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:10
Type Parameters
| Type Parameter |
|---|
TCollections extends CollectionRegistry |
TName extends CollectionKanbanName<TCollections> |
Properties
Card?
optional Card?: Snippet<[CollectionRow<TCollections[TName]>]>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:23
Card override. Omit to auto-derive the card from field structure (RFC V.3).
class?
optional class?: string;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:29
client
client: CollectionClient<TCollections>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:11
collectionName
collectionName: TName;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:12
detailParentRouteKey?
optional detailParentRouteKey?: string;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:19
detailRouteKey?
optional detailRouteKey?: string;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:18
groupBy
groupBy: Extract<keyof CollectionRow<TCollections[TName]>>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:13
lanes?
optional lanes?: readonly AuthoredLaneInput[];Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:15
Lane subset pick/order with optional labels/colours. Omit to derive from the groupBy field (RFC V.3).
onCardMove?
optional onCardMove?: (move) => Promise<void>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:28
Move handler. Omit for the default optimistic move that writes toLane into the groupBy
field with rollback on failure (RFC V.3c).
Parameters
| Parameter | Type |
|---|---|
move |
CollectionKanbanMove<CollectionRow<TCollections[TName]>> |
Returns
Promise<void>
queryOptions?
optional queryOptions?: CollectionQuery<CollectionRow<TCollections[TName]>>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:16
RecordRepresentation?
optional RecordRepresentation?: Snippet<[CollectionRow<TCollections[TName]>]>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:21
Detail-surface override. Omit for a schema-derived CollectionForm for the record (RFC V.3).
rowKey?
optional rowKey?: Extract<keyof CollectionRow<TCollections[TName]>, string>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:17
Type Aliases
CollectionKanban
type CollectionKanban<TCollections, TName> = InstanceType<typeof CollectionKanban>;Defined in: packages/ui/build/collection-kanban/collection-kanban.svelte.d.ts:24
Type Parameters
| Type Parameter |
|---|
TCollections extends CollectionRegistry |
TName extends CollectionKanbanName<TCollections> |
CollectionKanbanName
type CollectionKanbanName<TCollections> = Extract<keyof TCollections, string>;Defined in: packages/ui/build/collection-kanban/collection-kanban.types.d.ts:4
Type Parameters
| Type Parameter |
|---|
TCollections extends CollectionRegistry |
Variables
CollectionKanban
const CollectionKanban: $$IsomorphicComponent;Defined in: packages/ui/build/collection-kanban/collection-kanban.svelte.d.ts:24