UIFieldInput
Defined in: packages/core/src/fields/ui/types.ts:37
Configuration input for a ui() field — a UI-only field (no stored
value) that renders a fully custom Field (and optional Cell) component.
Extends
Section titled “Extends”BaseUIFieldInput<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:
UIFieldAdminInput<TCollectionSlug> &object
Defined in: packages/core/src/fields/ui/types.ts:42
Admin UI configuration for this UI field.
Type Declaration
Section titled “Type Declaration”components
Section titled “components”components:
object
components.Cell?
Section titled “components.Cell?”
optionalCell?:ApplyComponent<TComponent,UIFieldCellProps<TCollectionSlug>>
When set, the list view shows a column rendering this. Omit to show no column.
components.Field
Section titled “components.Field”Field:
ApplyComponent<TComponent,UIFieldComponentProps<TCollectionSlug>>
Rendered in the admin edit form at this field’s position.
Overrides
Section titled “Overrides”description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:516
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?
Section titled “label?”
optionallabel?:string
Defined in: packages/core/src/fields/baseTypes.ts:507
Display label for the field in the admin form.
Inherited from
Section titled “Inherited from”
optionalmeta?:TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:546