ui

ui<TCollectionSlug, TFieldMeta, TComponent>(props): UIField<TCollectionSlug, TFieldMeta, TComponent>

Defined in: packages/core/src/fields/ui/config.ts:29

Renders a fully custom admin-form field with no data representation. Dropped by getDataFields — never reaches schema, validation, type-gen, RBAC, indexing, or default-value resolution. Legal in any fields record (a collection/global’s own, a group()’s, a group-shaped array()’s items, a blocks() block’s own).

Type Parameters

TCollectionSlug

TCollectionSlug extends string = string

Types Field/Cell’s data and admin.condition’s data against that resource’s real document.

TFieldMeta

TFieldMeta extends object = { }

TComponent

TComponent extends ComponentHKT = ComponentHKT

Parameters

props

UIFieldInput<TCollectionSlug, TFieldMeta, TComponent>

UI field configuration: admin.components and layout options.

Returns

UIField<TCollectionSlug, TFieldMeta, TComponent>

The resolved UIField definition with defaults applied.

Example

defineCollection({
  fields: {
    wordCount: ui<typeof TABLE_SLUG_PAGES>({
      admin: { components: { Field: WordCountField } },
    }),
  },
})