Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add field groups #8088

Merged
merged 3 commits into from
Nov 16, 2022
Merged

Add field groups #8088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
708861d
Add field groups
emmatown Nov 16, 2022
09f729d
update changeset copy
dcousens Nov 16, 2022
1157235
update documentation copy
dcousens Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/warm-gifts-change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@keystone-6/core': minor
---

Adds a new `group` function for grouping fields in the Admin UI
33 changes: 33 additions & 0 deletions docs/pages/docs/fields/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,39 @@ export default config({
});
```

{% if $nextRelease %}

## Groups

Fields can be grouped together in the Admin UI using the `group` function, with a customisable `label` and `description`.

```typescript
import { config, list, group } from '@keystone-6/core';
import { text } from '@keystone-6/core/fields';

export default config({
lists: {
SomeListName: list({
fields: {
...group({
label: 'Group label',
description: 'Group description',
fields: {
someFieldName: text({ /* ... */ }),
/* ... */
},
}),
/* ... */
},
}),
/* ... */
},
/* ... */
});
```

{% /if %}

## Scalar types

- [BigInt](./bigint)
Expand Down
9 changes: 8 additions & 1 deletion examples/assets-local/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,9 +292,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -351,6 +352,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/assets-s3/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,9 +292,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -351,6 +352,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/auth/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -235,6 +236,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/basic/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,9 +446,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -505,6 +506,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/blog/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -312,6 +313,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/custom-admin-ui-logo/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -312,6 +313,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/custom-admin-ui-navigation/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -312,6 +313,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/custom-admin-ui-pages/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -312,6 +313,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/custom-field-view/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -315,6 +316,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/custom-field/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -167,6 +168,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/custom-session-validation/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -353,6 +354,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/default-values/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,9 +271,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -330,6 +331,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/document-field-customisation/keystone-server/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -303,6 +304,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
9 changes: 8 additions & 1 deletion examples/document-field/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,10 @@ type KeystoneAdminUIListMeta {
pageSize: Int!
labelField: String!
fields: [KeystoneAdminUIFieldMeta!]!
groups: [KeystoneAdminUIFieldGroupMeta!]!
initialSort: KeystoneAdminUISort
isHidden: Boolean!
isSingleton: Boolean
isSingleton: Boolean!
}

type KeystoneAdminUIFieldMeta {
Expand Down Expand Up @@ -327,6 +328,12 @@ enum QueryMode {
insensitive
}

type KeystoneAdminUIFieldGroupMeta {
label: String!
description: String
fields: [KeystoneAdminUIFieldMeta!]!
}

type KeystoneAdminUISort {
field: String!
direction: KeystoneAdminUISortDirection!
Expand Down
Loading