relationship
relationship<
TCollectionSlug,TFieldKey,TFieldMeta,TTargetSlug>(options):RelationshipField<TCollectionSlug,TFieldMeta,TTargetSlug>
Defined in: packages/react/src/index.ts:316
Defines a relationship field with React-typed component slots.
Drop-in replacement for @vexcms/core’s relationship, with the same generics
minus the component slot: relationship<"articles", "author">({ … }) types
index.additionalFields, admin.condition and validate() against articles.
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends string = string
TFieldKey
Section titled “TFieldKey”TFieldKey extends string = never
TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
TTargetSlug
Section titled “TTargetSlug”TTargetSlug extends string = string
Parameters
Section titled “Parameters”options
Section titled “options”RelationshipFieldInput<TCollectionSlug, TFieldKey, TFieldMeta, TTargetSlug>
Relationship field configuration.
Returns
Section titled “Returns”RelationshipField<TCollectionSlug, TFieldMeta, TTargetSlug>
The resolved relationship field definition.