RelationshipFieldAdminInput
Defined in: packages/core/src/fields/relationship/types.ts:24
Admin configuration input specific to a relationship field instance.
Extends FieldAdminConfigInput with a components slot that lets a
single field override the preview renderer — taking precedence over the target
collection’s admin.components.preview.
- RelationshipFieldAdminConfig for the resolved type after defaults are applied
- FieldAdminConfigInput for the base admin properties
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
The target collection slug, inferred from the field’s collection option.
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
Properties
Section titled “Properties”cellAlignment?
Section titled “cellAlignment?”
optionalcellAlignment?:Alignment
Defined in: packages/core/src/fields/baseTypes.ts:137
Content alignment in data table cells. ‘left’ | ‘right’ | ‘center’
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.cellAlignment
components?
Section titled “components?”
optionalcomponents?:object
Defined in: packages/core/src/fields/relationship/types.ts:32
Custom component overrides specific to this relationship field instance.
These take precedence over the target collection’s admin.components.
preview?
Section titled “preview?”
optionalpreview?:ApplyComponent<TComponent,RelationshipPreviewProps<TCollectionSlug>>
Per-field override for rendering this relationship’s docs. Wins over
the target collection’s admin.components.preview. TCollectionSlug is the
target slug (fieldDef.collection.slug).
hidden?
Section titled “hidden?”
optionalhidden?:boolean
Defined in: packages/core/src/fields/baseTypes.ts:104
Hide this field from the admin form. Hidden fields are still stored in the database.
Default: false
Inherited from
Section titled “Inherited from”placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Defined in: packages/core/src/fields/baseTypes.ts:133
Placeholder text shown in the input when empty.
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.placeholder
position?
Section titled “position?”
optionalposition?:"main"|"sidebar"
Defined in: packages/core/src/fields/baseTypes.ts:120
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:111
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?:"full"|"half"
Defined in: packages/core/src/fields/baseTypes.ts:129
Width of the field within its row.
"full"— spans the full width"half"— spans half the width (two fields per row)
Default: "full"