BaseUIField
Defined in: packages/core/src/fields/baseTypes.ts:648
Resolved base UI-field definition, after defaults are applied by the field config function.
BaseUIFieldInput for the user-facing input type
Extends
Section titled “Extends”Omit<BaseField<TCollectionSlug,TFieldMeta>,"required"|"defaultValue"|"index"|"interfaceDescription"|"interfaceType"|"validate"|"admin">
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends VexResourceSlug = VexResourceSlug
TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
Properties
Section titled “Properties”admin:
UIFieldAdminConfig<TCollectionSlug>
Defined in: packages/core/src/fields/baseTypes.ts:662
Resolved admin UI configuration with all defaults applied.
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”Omit.meta