UIFieldAdminInput
Defined in: packages/core/src/fields/baseTypes.ts:606
The subset of FieldAdminConfigInput meaningful for a kind: "ui"
field — no stored value, so no placeholder/cellAlignment. collapsible()
and ui() extend it with their own extra options; row() and tabs() use
it as-is.
Extends
Section titled “Extends”Pick<FieldAdminConfigInput<TCollectionSlug>,"condition"|"hidden"|"readOnly"|"position"|"width">
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends VexResourceSlug = VexResourceSlug
Properties
Section titled “Properties”condition?
Section titled “condition?”
optionalcondition?: (props) =>boolean
Defined in: packages/core/src/fields/baseTypes.ts:280
Shows the field only while this returns true; a hidden field also skips
required and validate(). A condition that throws counts as met.
Declared with method syntax so the parameter is checked bivariantly: a
field authored for one collection stays assignable to the generic field
unions the admin views hold. To author a condition separately, type it as FieldCondition.
Parameters
Section titled “Parameters”FieldConditionProps<TCollectionSlug>
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Pick.condition
hidden?
Section titled “hidden?”
optionalhidden?:boolean
Defined in: packages/core/src/fields/baseTypes.ts:287
Hide this field from the admin form. Hidden fields are still stored in the database.
Default: false
Inherited from
Section titled “Inherited from”position?
Section titled “position?”
optionalposition?:"main"|"sidebar"
Defined in: packages/core/src/fields/baseTypes.ts:303
Position of the field in the form layout.
"main"— placed in the main content area"sidebar"— placed in the sidebar panel
Default: "main"
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.position
readOnly?
Section titled “readOnly?”
optionalreadOnly?:boolean
Defined in: packages/core/src/fields/baseTypes.ts:294
Make this field read-only in the admin form. The value is displayed but cannot be edited.
Default: false
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.readOnly
width?
Section titled “width?”
optionalwidth?:string
Defined in: packages/core/src/fields/baseTypes.ts:311
Width of the field within its row, as any CSS width ("50%", "240px").
A row() lays its children out with flex-wrap, sharing a line when their
widths allow; below the sm breakpoint every field is full width.
Default: "100%"