RelationshipFieldAdminConfig
Defined in: packages/core/src/fields/relationship/types.ts:48
Resolved admin configuration for a relationship field after defaults are applied.
RelationshipFieldAdminInput for the user-facing input type
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
The target collection slug.
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
Properties
Section titled “Properties”cellAlignment
Section titled “cellAlignment”cellAlignment:
Alignment
Defined in: packages/core/src/fields/baseTypes.ts:159
Text alignment for this field’s column in the data table.
Inherited from
Section titled “Inherited from”FieldAdminConfig.cellAlignment
components
Section titled “components”components:
object
Defined in: packages/core/src/fields/relationship/types.ts:56
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”hidden:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:151
Whether the field is hidden from the admin form.
Inherited from
Section titled “Inherited from”placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Defined in: packages/core/src/fields/baseTypes.ts:161
Placeholder text shown in the input when empty.
Inherited from
Section titled “Inherited from”position
Section titled “position”position:
"main"|"sidebar"
Defined in: packages/core/src/fields/baseTypes.ts:155
Position of the field in the form layout — "main" or "sidebar".
Inherited from
Section titled “Inherited from”readOnly
Section titled “readOnly”readOnly:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:153
Whether the field is read-only in the admin form.
Inherited from
Section titled “Inherited from”width:
"full"|"half"
Defined in: packages/core/src/fields/baseTypes.ts:157
Width of the field within its row — "full" or "half".