UIField
Defined in: packages/core/src/fields/ui/types.ts:55
Resolved ui() field definition after defaults are applied.
Extends
Section titled “Extends”BaseUIField<TCollectionSlug,TFieldMeta>
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends VexResourceSlug = VexResourceSlug
TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
Properties
Section titled “Properties”admin:
UIFieldAdminConfig<TCollectionSlug> &object
Defined in: packages/core/src/fields/ui/types.ts:61
Resolved admin UI configuration with all defaults applied.
Type Declaration
Section titled “Type Declaration”components
Section titled “components”components:
object
components.Cell?
Section titled “components.Cell?”
optionalCell?:ApplyComponent<TComponent,UIFieldCellProps<TCollectionSlug>>
components.Field
Section titled “components.Field”Field:
ApplyComponent<TComponent,UIFieldComponentProps<TCollectionSlug>>
Overrides
Section titled “Overrides”description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:585
Semantic description of the field. Used in three places:
- Helper text rendered below the field input in the admin form UI.
- As the Zod
.meta({ description })value for form validation. - As the JSDoc comment on the generated document interface property.
To write a separate JSDoc comment, use interfaceDescription in addition.
Inherited from
Section titled “Inherited from”label:
string
Defined in: packages/core/src/fields/baseTypes.ts:567
Display label shown in the admin form. Always set — inferred from the field key if not provided.
Inherited from
Section titled “Inherited from”meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:592
Inherited from
Section titled “Inherited from”
readonlytype:"ui"
Defined in: packages/core/src/fields/ui/types.ts:60