Norbital

ui/build/collection-table/collection-card-derivation

Type Aliases

AuthoredLaneInput

type AuthoredLaneInput = string | AuthoredLane;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-card-derivation.d.ts:114

AutoCardModel

type AutoCardModel = typeof autoCardModelSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-card-derivation.d.ts:55

Functions

Parameter	Type
`collectionName`	`string`
`override?`	`string`
`t?`	`any`

deriveAutoCard()

function deriveAutoCard(
   fields,
   columnOrder,
   options): object;

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

The auto card model derived from column card-role hints and, where a role is unfilled, the field structure (RFC V.2d / V.3).

title: card:'title' → the first non-nullable text-ish field → the first visible column → the collection record_label (when present).
subtitle: card:'subtitle' columns → the next text-ish / relation fields (title excluded), capped at two.
badge: card:'badge' → the first enum-backed field.

columnOrder is the visible column key order used for the title fallback.

Parameters

Parameter	Type
`fields`	readonly `CollectionField`<`string`>[]
`columnOrder`	readonly `string`[]
`options`	{ `hasRecordLabel`: `boolean`; `roles?`: { `badge?`: `string`; `subtitle?`: readonly `string`[]; `title?`: `string`; }; }
`options.hasRecordLabel`	`boolean`
`options.roles?`	{ `badge?`: `string`; `subtitle?`: readonly `string`[]; `title?`: `string`; }
`options.roles.badge?`	`string`
`options.roles.subtitle?`	readonly `string`[]
`options.roles.title?`	`string`

Returns

subtitles

readonly subtitles: readonly string[];

Secondary field names, capped at two, title excluded.

title

readonly title:
  | {
  kind: "field";
  name: string;
}
  | {
  kind: "record-label";
};

Parameter	Type
`field`	`CollectionField`<`string`> \| `undefined`

Parameter	Type	Description
`model`	{ `badge?`: `string`; `subtitles`: readonly `string`[]; `title`: \| { `kind`: `"field"`; `name`: `string`; } \| { `kind`: `"record-label"`; }; }	-
`model.badge?`	`string`	Badge field name, if any.
`model.subtitles`	readonly `string`[]	Secondary field names, capped at two, title excluded.
`model.title`	\| { `kind`: `"field"`; `name`: `string`; } \| { `kind`: `"record-label"`; }	-
`record`	`object`	-
`text`	`CardText`	-

Parameter	Type	Description
`model`	{ `badge?`: `string`; `subtitles`: readonly `string`[]; `title`: \| { `kind`: `"field"`; `name`: `string`; } \| { `kind`: `"record-label"`; }; }	-
`model.badge?`	`string`	Badge field name, if any.
`model.subtitles`	readonly `string`[]	Secondary field names, capped at two, title excluded.
`model.title`	\| { `kind`: `"field"`; `name`: `string`; } \| { `kind`: `"record-label"`; }	-
`text`	`CardText`	-

Parameter	Type
`name`	`string`

mergeAuthoredLanes()

function mergeAuthoredLanes(derived, authored?): Map<string, {
  color?: string;
  label: string;
  value: string;
}>;

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-card-derivation.d.ts:126

Merge schema-derived lane metadata with authored view lanes. Authored labels/colours override schema-derived lanes; string lanes inherit derived metadata when present.

Parameters

Parameter	Type
`derived`	readonly `object`[]
`authored?`	readonly `AuthoredLaneInput`[]

Returns

Map<string, { color?: string; label: string; value: string; }>

optionalCollectionRecordId()

function optionalCollectionRecordId(record): string | undefined;

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

The framework row key, when the value is a persisted row rather than a draft.

This is the single place the framework reads id off a caller-supplied object, so an authored surface never has to: it hands over the record it already has and the framework tells create and update apart from the presence of the key.

Parameters

Parameter	Type
`record`	`object` \| `null` \| `undefined`

Returns

string | undefined

parseAuthoredLaneValues()

function parseAuthoredLaneValues(lanes): string[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-card-derivation.d.ts:116

Lane values in authored order — accepts { value, label?, color? }[] or string[].

Parameters

Parameter	Type
`lanes`	readonly `AuthoredLaneInput`[]

Returns

string[]

pickFieldNames()

function pickFieldNames(fields, names): string[];

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

Ordered pick of existing field names, preserving the requested order (RFC V.2b fields).

Parameters

Parameter	Type
`fields`	readonly `CollectionField`<`string`>[]
`names`	readonly `string`[]

Returns

string[]

resolvedRecordMetadataFor()

function resolvedRecordMetadataFor<TRow>(
   record,
   metadata,
   t): readonly ResolvedCollectionRecordMetadata[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-table/collection-card-derivation.d.ts:138

Resolve the metadata cells a collection surface shows for one record, with the catalog-back copy both the table and the board use for the framework-provided entries.

Type Parameters

Type Parameter
`TRow` extends `object`

Parameters

Parameter	Type
`record`	`TRow`
`metadata`	`any`
`t`	`Translate`

Returns

readonly ResolvedCollectionRecordMetadata[]