Norbital

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

Interfaces

CollectionKanbanField

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

Type Parameters

Type Parameter	Default type
`TRow` extends `object`	-
`TRenderer` extends `Component`<`never`>	`Component`<`ConfirmationProps`>

Properties

card?

optional card?: CollectionKanbanCardRole;

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

Optional explicit placement; undeclared roles are filled from declared field order.

key

key: Exclude<Extract<keyof TRow, string>>;

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

relationOptions?

optional relationOptions?: CollectionRelationOptions<CollectionRecord>;

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

renderer?

optional renderer?: TRenderer;

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

Explicit datatype renderer override. Omit for automatic relationship/datatype routing.

rendererProps?

optional rendererProps?: any;

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

CollectionKanbanFieldComponent()

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

Type Parameters

Type Parameter
`TRow` extends `object`

CollectionKanbanFieldComponent<TRenderer>(
   this,
   internals,
   props): object;

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

Type Parameters

Type Parameter	Default type
`TRenderer` extends `Component`<`never`, { }, `string`>	`Component`<`FieldRendererProps`, { }, `string`>

Parameters

Parameter	Type
`this`	`void`
`internals`	`Brand`
`props`	`CollectionKanbanFieldPrimitiveProps`<`TRow`, `TRenderer`>

Returns

object

Constructors

Constructor

new CollectionKanbanFieldComponent<TRenderer>(options): SvelteComponent<CollectionKanbanFieldPrimitiveProps<TRow, TRenderer>>;

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

Parameters

Parameter	Type
`options`	`ComponentConstructorOptions`<`CollectionKanbanFieldPrimitiveProps`<`TRow`, `TRenderer`>>

Returns

SvelteComponent<CollectionKanbanFieldPrimitiveProps<TRow, TRenderer>>

Properties

element?

optional element?: () => HTMLElement;

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

Returns

HTMLElement

z_$$bindings?

optional z_$$bindings?: string;

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

CollectionKanbanFieldsComposition

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

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

Field

Field: CollectionKanbanFieldComponent<TRow>;

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

CollectionKanbanMove

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

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:11

record

record: Row;

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

toLane

toLane: string;

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

CollectionKanbanProps

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

Type Parameters

Type Parameter
`TCollections` extends `CollectionRegistry`
`TName` extends `CollectionKanbanName`<`TCollections`>

Properties

bulkPipelines?

optional bulkPipelines?: readonly CollectionPipeline<CollectionRow<TCollections[TName]>>[];

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

Card?

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

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

Whole-card layout override. Declared fields remain the canonical automatic-card contract.

class?

optional class?: string;

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

client

client: CollectionDbClient<TCollections, TName>;

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

collection

collection: TName;

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

description?

optional description?: string;

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

exportPipelines?

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

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

fields

fields: Snippet<[CollectionKanbanFieldsComposition<CollectionRow<TCollections[TName]>>]>;

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

Required card field declaration. The framework never enumerates schema fields into cards; omitted fields are omitted and omitted renderers use the automatic datatype strategy.

groupBy

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

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

importPipelines?

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

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

integrations?

optional integrations?: readonly CollectionIntegrationStatus[];

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

lanes?

optional lanes?: readonly AuthoredLaneInput[];

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

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

optional navigation?: Snippet<[]>;

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

Leads the toolbar: the scope the board steps through (a day, a month).

onCardMove?

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

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

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>

query?

optional query?: Omit<CollectionLiveQuery<TCollections[TName]>, "limit">;

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

The board is one live prefix, so its ordering is a scalar and it takes no after or limit.

recordMetadata?

optional recordMetadata?: any;

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

rows?

optional rows?: number;

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

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:49

title?

optional title?: string;

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

view?

optional view?: string;

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

Type Aliases

CollectionKanbanCardRole

type CollectionKanbanCardRole = "title" | "subtitle" | "badge";

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

CollectionKanbanFieldPrimitiveProps

type CollectionKanbanFieldPrimitiveProps<TRow, TRenderer> = Omit<CollectionKanbanField<TRow, TRenderer>, "key"> & object;

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

Type Declaration

name

name: CollectionKanbanFieldName<TRow>;

Type Parameters

Type Parameter	Default type
`TRow` extends `object`	-
`TRenderer` extends `Component`<`never`>	`Component`<`ConfirmationProps`>

CollectionKanbanName

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

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

Type Parameters

Type Parameter
`TCollections` extends `CollectionRegistry`