Update labelField docstrings

keystonejs · Feb 8, 2021 · 442f0f9 · 442f0f9
1 parent 1d54c4b
commit 442f0f9
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/packages-next/types/src/config/lists.ts b/packages-next/types/src/config/lists.ts
@@ -77,9 +77,9 @@ export type ListAdminUIConfig<
 > = {
   /**
    * The field to use as a label in the Admin UI. If you want to base the label off more than a single field, use a virtual field and reference that field here.
-   * @default 'name' if it exists, otherwise 'id'
+   * @default 'label', if it exists, falling back to 'name', then 'title', and finally 'id', which is guaranteed to exist.
    */
-  labelField?: keyof Fields; // path of the field to use as the label for items in the list, defaults to 'label', 'name', 'title' or 'id'
+  labelField?: keyof Fields;
 
   /** The path that the list should be at in the Admin UI */
   // Not currently used. Should be passed into `keystone.createList()`.