Norbital

ui/build/collection-table/collection-table.types

Interfaces

CollectionTableColumn

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

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

card?

optional card?: "title" | "subtitle" | "badge";

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

Which auto-card slot this column feeds (title/subtitle/badge) when no ListCard is given.

hideable?

optional hideable?: boolean;

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

key

key: Extract<keyof TRow>;

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

label?

optional label?: string;

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

maxWidth?

optional maxWidth?: number;

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

minWidth?

optional minWidth?: number;

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

pinnable?

optional pinnable?: boolean;

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

Parameter	Type
`context`	{ `field`: `CollectionField`; `row`: `TRow`; `value`: `unknown`; }
`context.field`	`CollectionField`
`context.row`	`TRow`
`context.value`	`unknown`

resizable?

optional resizable?: boolean;

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

sortable?

optional sortable?: boolean;

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

width?

optional width?: number;

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

CollectionTableColumnsComposition

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

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

Column

Column: CollectionTableColumnComponent<TRow>;

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

CollectionTableFeatures

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

Properties

create?

readonly optional create?: boolean;

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

filter?

readonly optional filter?: boolean;

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

search?

readonly optional search?: boolean;

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

CollectionTableInitialFilter

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

A filter condition the view opens with, seeded into the filter builder as an ordinary row.

This is the builder's vocabulary, not the wire's: field is the same path the field picker uses (effective_range, or relation.field), and value is what the operand editor would produce — a calendar day for contains_date, which collectionFilterClause converts to an instant on its way out. Seeding the wire shape instead would mean reversing that conversion, and unwrapping the %…% an ilike operand is published with.

A seed is a default, not a constraint. It arrives as a normal chip the operator can edit or remove, and removing it is remembered per view — unlike a condition baked into query.where, which is invisible, locked, and can only be narrated by the "Applied by this view" tooltip.

Properties

field

readonly field: string;

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

Field path as the picker addresses it: status, or agreement_employment.employee_number.

operator

readonly operator: CollectionFilterOperator;

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

value?

readonly optional value?: unknown;

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

Omitted for the operators that take none (isNull, isNotNull).

CollectionTablePipeline

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

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

description?

readonly optional description?: string;

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

getDisabledReason?

readonly optional getDisabledReason?: (selectedRows) => string | null;

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

Returns user-facing copy when the current selection cannot run this pipeline.

Parameters

Parameter	Type
`selectedRows`	readonly `TRow`[]

Returns

string | null

icon?

readonly optional icon?: string;

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

id

readonly id: string;

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

label

readonly label: string;

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

requiresSelection?

readonly optional requiresSelection?: boolean;

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

Keeps the pipeline visible but muted until at least one row is selected.

Methods

run()

run(context): Effect<unknown, unknown>;

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

Parameters

Parameter	Type
`context`	`CollectionTablePipelineContext`<`TRow`>

Type Parameter
`TRow` extends `object`

Properties

collectionName

readonly collectionName: string;

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

selectedRows

readonly selectedRows: readonly TRow[];

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

CollectionTableRowActionContext

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

Type Parameters

Type Parameter
`TRow` extends `object`

Properties

hovered

hovered: boolean;

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

metadata

metadata: readonly ResolvedCollectionRecordMetadata[];

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

row

row: TRow;

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

Type Aliases

CollectionName

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

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

Type Parameters

Type Parameter
`TCollections` extends `CollectionRegistry`

CollectionTableColumnPrimitiveProps

type CollectionTableColumnPrimitiveProps<TRow> = Omit<CollectionTableColumn<TRow>, "key"> & object;

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

Type Declaration

name

name: CollectionTableFieldName<TRow>;

Type Parameters

Type Parameter
`TRow` extends `object`

CollectionTableIntegrationState

type CollectionTableIntegrationState = typeof collectionTableIntegrationStateSchema.Type;

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

CollectionTableIntegrationStatus

type CollectionTableIntegrationStatus = typeof collectionTableIntegrationStatusSchema.Type;

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

CollectionTableProps

type CollectionTableProps<TCollections, TName, TRow> = CollectionTableBaseProps<TCollections, TName, TRow>;

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

Type Parameters

Type Parameter	Default type
`TCollections` extends `CollectionRegistry`	`CollectionRegistry`
`TName` extends `CollectionName`<`TCollections`>	`CollectionName`<`TCollections`>
`TRow` extends `object`	`CollectionTableRow`<`TCollections`, `TName`>

CollectionTableRow

type CollectionTableRow<TCollections, TName> = CollectionRow<TCollections[TName]>;

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

Type Parameters

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

Functions

collectionTableColumnCanSort()

function collectionTableColumnCanSort(field, options): boolean;

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

Parameters

Parameter	Type
`field`	`CollectionField`
`options`	`CollectionTableSortability`

Returns

boolean