FieldComponentProps
Defined in: packages/core/src/fields/types.ts:170
Props passed to an admin.components.Field override’s replacement — the
same props the admin field’s own Field.tsx receives (decision 5), plus
renderDefault to fall back to the previous stage in the override chain
(built-in → root per-type → this field instance), same composition as
admin.components.Input.
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends BaseFieldMeta = BaseFieldMeta
TField
Section titled “TField”TField extends AdminField<TFieldMeta> = AdminField<TFieldMeta>
Narrows fieldDef to a specific field type.
Properties
Section titled “Properties”collection
Section titled “collection”collection:
CollectionConfig<{ }, { },string,Record<string,AdminField>,ComponentHKT,boolean,boolean,string> |GlobalConfig<{ }, { },string,Record<string,AdminField<{ }>>,ComponentHKT,boolean>
Defined in: packages/core/src/fields/types.ts:182
The config for the collection this field is attached to.
documentStatus?
Section titled “documentStatus?”
optionaldocumentStatus?:"draft"|"published"
Defined in: packages/core/src/fields/types.ts:184
Necessary for Edit Views. What is the status of this document, ‘draft’ or ‘published’?
fieldDef
Section titled “fieldDef”fieldDef:
TField
Defined in: packages/core/src/fields/types.ts:177
The resolved field definition — narrows to the specific field type via TField.
index?
Section titled “index?”
optionalindex?:number
Defined in: packages/core/src/fields/types.ts:180
name:
string
Defined in: packages/core/src/fields/types.ts:175
The field key name from the collection config, e.g. "title". Used as the form field name.
readOnly
Section titled “readOnly”readOnly:
boolean
Defined in: packages/core/src/fields/types.ts:179
Whether the field is non-editable — derived from fieldDef.admin.readOnly or permission checks.
renderDefault?
Section titled “renderDefault?”
optionalrenderDefault?:ComponentType<FieldComponentProps<TFieldMeta,TField>>
Defined in: packages/core/src/fields/types.ts:186
Renders the previous stage of the Field override chain.