RelationshipFieldAdminInput
Defined in: packages/core/src/fields/relationship/types.ts:29
Admin configuration input specific to a relationship field instance.
Extends FieldAdminConfigInput with a components slot that lets a
single field override the preview renderer. This is the only supported
location for a relationship preview override (ARCH-1) — target collections
do not have their own admin.components.preview.
- RelationshipFieldAdminConfig for the resolved type after defaults are applied
- FieldAdminConfigInput for the base admin properties
Extends
Section titled “Extends”FieldAdminConfigInput<TCollectionSlug,TComponent>
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends VexResourceSlug = VexResourceSlug
The collection (or global) this field belongs to; types condition’s data.
TTargetSlug
Section titled “TTargetSlug”TTargetSlug 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:319
Content alignment in data table cells. ‘left’ | ‘right’ | ‘center’
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.cellAlignment
columnWidth?
Section titled “columnWidth?”
optionalcolumnWidth?:number
Defined in: packages/core/src/fields/baseTypes.ts:354
Pixel width of this field’s own column in the list table (Decision
48) — unlike enableSorting/enableHiding, this has no type-based
resolution here: the default lives only in resolveListViewColumnConfig’s
own FIELD_TYPE_DEFAULT_WIDTH map, consulted when neither this nor
the active view’s own column entry (ColumnEntry.width, which always
wins) sets one. Named columnWidth, not width, to avoid colliding
with this same interface’s own width (the field’s CSS row width in
the EDIT form layout) — a different axis entirely.
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.columnWidth
components?
Section titled “components?”
optionalcomponents?:FieldSlotComponentsInput<TComponent> &object
Defined in: packages/core/src/fields/relationship/types.ts:39
Base per-field slot overrides (S6) PLUS preview, the relationship-only override —
the only supported location for a custom preview (ARCH-1: target collections do not
support their own admin.components.preview).
Type Declaration
Section titled “Type Declaration”preview?
Section titled “preview?”
optionalpreview?:ApplyComponent<TComponent,RelationshipPreviewProps<TTargetSlug>>
Overrides
Section titled “Overrides”FieldAdminConfigInput.components
enableHiding?
Section titled “enableHiding?”
optionalenableHiding?:boolean
Defined in: packages/core/src/fields/baseTypes.ts:343
Allow this field’s column to be hidden from the list table via the
columns menu. Every column is hideable by default (list-view-overhaul
Decision 47, revised) — set false to opt a specific field OUT (e.g.
a title/identity column the list should never let a user hide).
Default: true
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.enableHiding
enableSorting?
Section titled “enableSorting?”
optionalenableSorting?:boolean
Defined in: packages/core/src/fields/baseTypes.ts:334
Allow the list table’s column header for this field to sort the table.
The field must lead some declared index (or be defaultView.sort.field) —
checked by validateSavedListViewConfig.
Default: false
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.enableSorting
hidden?
Section titled “hidden?”
optionalhidden?:boolean
Defined in: packages/core/src/fields/baseTypes.ts:287
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:315
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:303
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:294
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?:string
Defined in: packages/core/src/fields/baseTypes.ts:311
Width of the field within its row, as any CSS width ("50%", "240px").
A row() lays its children out with flex-wrap, sharing a line when their
widths allow; below the sm breakpoint every field is full width.
Default: "100%"
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:280
Shows the field only while this returns true; a hidden field also skips
required and validate(). A condition that throws counts as met.
Declared with method syntax so the parameter is checked bivariantly: a
field authored for one collection stays assignable to the generic field
unions the admin views hold. To author a condition separately, type it as FieldCondition.
Parameters
Section titled “Parameters”FieldConditionProps<TCollectionSlug>
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”FieldAdminConfigInput.condition