collection-surface-model

Type Aliases

type AutoCardModel = typeof autoCardModelSchema.Type;

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

function createCollectionActionLabel(collectionName, t): string;

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

Parameter	Type
`collectionName`	`string`
`t`	`Translate`

string

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

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

Derive card roles only from the surface's explicit field order.

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

object

readonly optional badge?: string;

readonly subtitles: readonly string[];

readonly title:
  | {
  kind: "field";
  name: string;
}
  | {
  kind: "collection";
};

function optionalCollectionRecordId(record): string | undefined;

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

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

string | undefined

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

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

Type Parameter
`TRow` extends `object`

readonly ResolvedCollectionRecordMetadata[]