BaseUIFieldInput

Defined in: packages/core/src/fields/baseTypes.ts:626

Properties shared by all kind: "ui" field types (tabs, collapsible, row, ui) — the UI-field counterpart to BaseFieldInput, with every member meaningless for a field that stores no value removed.

See

BaseUIField for the resolved type after defaults are applied

Extends

• Omit<BaseFieldInput<TCollectionSlug, never, TFieldMeta>, "required" | "defaultValue" | "index" | "interfaceDescription" | "validate" | "admin">

Extended by

• TabsFieldInput
• CollapsibleFieldInput
• RowFieldInput
• UIFieldInput

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldMeta

TFieldMeta extends object = { }

Properties

admin?

optional admin?: UIFieldAdminInput<TCollectionSlug>

Defined in: packages/core/src/fields/baseTypes.ts:639

Admin UI configuration for this UI field.

---

description?

optional description?: string

Defined in: packages/core/src/fields/baseTypes.ts:516

Semantic description of the field. Used in three places:

1. Helper text rendered below the field input in the admin form UI.
2. As the Zod .meta({ description }) value for form validation.
3. As the JSDoc comment on the generated document interface property.

To write a separate JSDoc comment, use interfaceDescription in addition.

Inherited from

BaseFieldInput.description

---

label?

optional label?: string

Defined in: packages/core/src/fields/baseTypes.ts:507

Display label for the field in the admin form.

Inherited from

BaseFieldInput.label

---

meta?

optional meta?: TFieldMeta

Defined in: packages/core/src/fields/baseTypes.ts:546

Inherited from

Omit.meta