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

Type Parameters

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

Properties

card?

optional card?: CollectionTableCardRole;

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

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

key

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

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

label?

optional label?: string;

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

maxWidth?

optional maxWidth?: number;

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

minWidth?

optional minWidth?: number;

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

pinnable?

optional pinnable?: boolean;

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

relationOptions?

optional relationOptions?: CollectionRelationOptions<CollectionRecord>;

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

renderer?

optional renderer?: TRenderer;

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

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

rendererProps?

optional rendererProps?: any;

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

resizable?

optional resizable?: boolean;

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

sortable?

optional sortable?: boolean;

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

width?

optional width?: number;

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

---

CollectionTableColumnsComposition

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

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

---

CollectionTableFeatures

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

Properties

create?

readonly optional create?: boolean;

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

filter?

readonly optional filter?: boolean;

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

search?

readonly optional search?: boolean;

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

---

CollectionTableRowActionContext

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

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

metadata

metadata: readonly ResolvedCollectionRecordMetadata[];

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

row

row: TRow;

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

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, TRenderer> = Omit<CollectionTableColumn<TRow, TRenderer>, "key"> & object;

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

Type Declaration

name

name: CollectionTableFieldName<TRow>;

Type Parameters

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

---

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

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

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

Parameters

Parameter	Type
field	CollectionField
options	CollectionTableSortability

Returns

boolean