Add ui.searchFields option (#6165)

keystonejs · Jul 25, 2021 · e4e6cf9 · e4e6cf9 · vercel · Jul 25, 2021
1 parent ee8a514
commit e4e6cf9
Show file tree

Hide file tree

Showing 34 changed files with 377 additions and 106 deletions.
diff --git a/.changeset/serious-pigs-attack.md b/.changeset/serious-pigs-attack.md
@@ -0,0 +1,7 @@
+---
+'@keystone-next/fields': major
+'@keystone-next/keystone': major
+'@keystone-next/types': major
+---
+
+Added `ui.searchFields` option to lists to allow searching by multiple fields in the Admin UI (the only current usage of this is in the select used in relationship fields) and to replace the usage of the `search` GraphQL argument which will be removed soon and should be replaced by using `contains` filters directly.
diff --git a/docs/pages/docs/apis/schema.mdx b/docs/pages/docs/apis/schema.mdx
@@ -68,6 +68,9 @@ Options:
 
 - `labelField`: Selects the field which will be used as the label column in the Admin UI.
   By default looks for a field called `'label'`, then falls back to `'name'`, then `'title'`, and finally `'id'`, which is guaranteed to exist.
+- `searchFields`: The fields used by the Admin UI when searching this list.
+  It is always possible to search by an id and `'id'` should not be specified in this option.
+  By default, the `labelField` is used if it has a string `contains` filter, otherwise none.
 - `description` (default: `undefined`): Sets the list description displayed in the Admin UI.
 - `isHidden` (default: `false`): Controls whether the list is visible in the navigation elements of the Admin UI.
   Can be either a boolean value, or an async function with an argument `{ session }` that returns a boolean value.
@@ -106,6 +109,7 @@ export default config({
       fields: { name: text({ /* ... */ }) },
       ui: {
         labelField: 'name',
+        searchFields: ['name', 'alternativeName'],
         description: '...',
         isHidden: ({ session }) => false,
         hideCreate: ({ session }) => false,

diff --git a/examples-staging/assets-cloud/schema.graphql b/examples-staging/assets-cloud/schema.graphql
@@ -396,6 +396,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -426,6 +427,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/assets-local/schema.graphql b/examples-staging/assets-local/schema.graphql
@@ -374,6 +374,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -404,6 +405,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/auth/schema.graphql b/examples-staging/auth/schema.graphql
@@ -216,6 +216,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -246,6 +247,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/basic/schema.graphql b/examples-staging/basic/schema.graphql
@@ -597,6 +597,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -627,6 +628,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/ecommerce/schema.graphql b/examples-staging/ecommerce/schema.graphql
@@ -1250,6 +1250,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -1280,6 +1281,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/embedded-nextjs/schema.graphql b/examples-staging/embedded-nextjs/schema.graphql
@@ -172,6 +172,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -202,6 +203,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/graphql-api-endpoint/schema.graphql b/examples-staging/graphql-api-endpoint/schema.graphql
@@ -566,6 +566,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -596,6 +597,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/playground/schema.graphql b/examples-staging/playground/schema.graphql
@@ -148,6 +148,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -178,6 +179,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/roles/schema.graphql b/examples-staging/roles/schema.graphql
@@ -536,6 +536,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -566,6 +567,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples-staging/sandbox/schema.graphql b/examples-staging/sandbox/schema.graphql
@@ -370,6 +370,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -400,6 +401,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/blog/schema.graphql b/examples/blog/schema.graphql
@@ -334,6 +334,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -364,6 +365,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/custom-admin-ui-logo/schema.graphql b/examples/custom-admin-ui-logo/schema.graphql
@@ -318,6 +318,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -348,6 +349,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/custom-field-view/schema.graphql b/examples/custom-field-view/schema.graphql
@@ -321,6 +321,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -351,6 +352,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/custom-field/schema.graphql b/examples/custom-field/schema.graphql
@@ -348,6 +348,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -378,6 +379,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/default-values/schema.graphql b/examples/default-values/schema.graphql
@@ -318,6 +318,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -348,6 +349,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/document-field/schema.graphql b/examples/document-field/schema.graphql
@@ -349,6 +349,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -379,6 +380,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/extend-graphql-schema/schema.graphql b/examples/extend-graphql-schema/schema.graphql
@@ -358,6 +358,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -388,6 +389,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!

diff --git a/examples/json/schema.graphql b/examples/json/schema.graphql
@@ -291,6 +291,7 @@ type KeystoneAdminUIFieldMeta {
   createView: KeystoneAdminUIFieldMetaCreateView!
   listView: KeystoneAdminUIFieldMetaListView!
   itemView(id: ID!): KeystoneAdminUIFieldMetaItemView
+  search: QueryMode
 }
 
 type KeystoneAdminUIFieldMetaCreateView {
@@ -321,6 +322,11 @@ enum KeystoneAdminUIFieldMetaItemViewFieldMode {
   hidden
 }
 
+enum QueryMode {
+  default
+  insensitive
+}
+
 type KeystoneAdminUISort {
   field: String!
   direction: KeystoneAdminUISortDirection!