Relationship

A relationship field represents a relationship between two lists.

Read our relationships guide for details on Keystone’s relationship model and how to configure them in your project.

• ref (required): A string of the form <listKey> or <listKey>.<fieldKey>.
• many (default: false): Configures the cardinality of the relationship.
• db.foreignKey: When true or an object, ensures the foreign Key for two-sided relationships is stored in the table for this list (only available on single relationships, and not on both sides of a 1:1 relationship)
  • map: Changes the column name in the database
• ui: Configures the display mode of the field in the Admin UI
  • displayMode (default: select): If count, only many: true relationships are supported
  • labelField: The field path from the related list to use for item labels in the select. Defaults to the labelField configured on the related list.
  • searchFields: The fields used by the Admin UI when searching by this relationship on the list view and in relationship fields. Nominated fields need to support the contains filter. Defaults to `ui.listView.searchFieldon the related list.
  • hideCreate (default: false). If true, the "Create related item" button is not shown in the item view.

import { config, list } from '@keystone-6/core';
import { relationship } from '@keystone-6/core/fields';

export default config({
  lists: {
    SomeListName: list({
      fields: {
        someFieldName: relationship({
          ref: '...',
          many: false,
          db: {
            foreignKey: {
              map: 'foreign_id',
            },
          },
          ui: {
            hideCreate: false,
            displayMode: 'select',
            labelField: 'name',
            displayMode: 'cards',
            cardFields: [...],
            linkToItem: true,
            removeMode: 'disconnect',
            inlineCreate: { fields: [...] },
            inlineEdit: { fields: [...] },
            inlineConnect: true,
            // Display mode: 'count'
            // requires many: true above
            displayMode: 'count',
           },
        }),
        /* ... */
      },
    }),
    /* ... */
  },
  /* ... */
});