RelationshipFieldAdminConfig
Defined in: packages/core/src/fields/relationship/types.ts:51
Resolved admin configuration for a relationship field after defaults are applied.
RelationshipFieldAdminInput for the user-facing input type
Extends
Section titled “Extends”FieldAdminConfig<TCollectionSlug,TComponent>
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends VexResourceSlug = VexResourceSlug
The collection (or global) this field belongs to.
TTargetSlug
Section titled “TTargetSlug”TTargetSlug 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:381
Text alignment for this field’s column in the data table.
Inherited from
Section titled “Inherited from”FieldAdminConfig.cellAlignment
columnWidth?
Section titled “columnWidth?”
optionalcolumnWidth?:number
Defined in: packages/core/src/fields/baseTypes.ts:399
Pixel width of this field’s own column in the list table. Optional — unlike enableSorting/enableHiding, the type default lives only in resolveListViewColumnConfig’s own FIELD_TYPE_DEFAULT_WIDTH map, not here.
Inherited from
Section titled “Inherited from”components
Section titled “components”components:
object&object
Defined in: packages/core/src/fields/relationship/types.ts:57
Base resolved slot overrides PLUS preview.
Type Declaration
Section titled “Type Declaration”afterInput
Section titled “afterInput”afterInput:
ComponentContributionInput<TComponent,unknown>[]
beforeInput
Section titled “beforeInput”beforeInput:
ComponentContributionInput<TComponent,unknown>[]
Cell:
ComponentOverrideInput<TComponent,unknown>[]
Description
Section titled “Description”Description:
ComponentOverrideInput<TComponent,unknown>[]
Field:
ComponentOverrideInput<TComponent,unknown>[]
Input:
ComponentOverrideInput<TComponent,unknown>[]
Label:
ComponentOverrideInput<TComponent,unknown>[]
Type Declaration
Section titled “Type Declaration”preview?
Section titled “preview?”
optionalpreview?:ApplyComponent<TComponent,RelationshipPreviewProps<TTargetSlug>>
Overrides
Section titled “Overrides”enableHiding
Section titled “enableHiding”enableHiding:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:397
Whether this field’s column may be hidden from the list table via the columns menu.
Inherited from
Section titled “Inherited from”enableSorting
Section titled “enableSorting”enableSorting:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:395
Whether the list table’s column header for this field may sort the table.
Inherited from
Section titled “Inherited from”FieldAdminConfig.enableSorting
hidden
Section titled “hidden”hidden:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:373
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:383
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:377
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:375
Whether the field is read-only in the admin form.
Inherited from
Section titled “Inherited from”width:
string
Defined in: packages/core/src/fields/baseTypes.ts:379
Width of the field within its row, any CSS width — e.g. "100%", "50%", "240px".
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”condition()?
Section titled “condition()?”
optionalcondition(props):boolean
Defined in: packages/core/src/fields/baseTypes.ts:371
Shows the field only while this returns true.
Parameters
Section titled “Parameters”FieldConditionProps<TCollectionSlug>
Returns
Section titled “Returns”boolean
FieldAdminConfigInput.condition
Inherited from
Section titled “Inherited from”FieldAdminConfig.condition