ui/build/collection-kanban/collection-kanban.types

Interfaces

CollectionKanbanMove

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:8

Type Parameters

Type Parameter
Row

Properties

fromLane

fromLane: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:10

record

record: Row;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:9

toLane

toLane: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:11

---

CollectionKanbanProps

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:13

Type Parameters

Type Parameter
TCollections extends CollectionRegistry
TName extends CollectionKanbanName<TCollections>

Properties

Card?

optional Card?: Snippet<[CollectionRow<TCollections[TName]>]>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:31

Card override. Omit to auto-derive the card from field structure (RFC V.3).

class?

optional class?: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:37

client

client: CollectionDbClient<TCollections>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:14

collection

collection: TName;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:15

description?

optional description?: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:26

exportPipelines?

optional exportPipelines?: readonly CollectionTablePipeline<CollectionRow<TCollections[TName]>>[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:27

groupBy

groupBy: Extract<keyof CollectionRow<TCollections[TName]>>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:17

importPipelines?

optional importPipelines?: readonly CollectionTablePipeline<CollectionRow<TCollections[TName]>>[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:28

integrations?

optional integrations?: readonly CollectionTableIntegrationStatus[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:29

lanes?

optional lanes?: readonly AuthoredLaneInput[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:19

Lane subset pick/order with optional labels/colours. Omit to derive from the groupBy field (RFC V.3).

onCardMove?

optional onCardMove?: (move) => Effect<void, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:36

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

Effect<void, unknown>

query?

optional query?: CollectionQuery<CollectionRow<TCollections[TName]>>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:22

recordMetadata?

optional recordMetadata?: any;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:23

rows?

optional rows?: number;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:21

Number of visual lane rows. Defaults to one horizontal row.

selectable?

optional selectable?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:24

title?

optional title?: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:25

view?

optional view?: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:16

Type Aliases

CollectionKanbanName

type CollectionKanbanName<TCollections> = Extract<keyof TCollections, string>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-kanban/collection-kanban.types.d.ts:7

Type Parameters

Type Parameter
TCollections extends CollectionRegistry