Skip to content

DataViews: Add groupByField support to grid layout #70752

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

Merged
merged 12 commits into from
Jul 21, 2025
Merged

DataViews: Add groupByField support to grid layout #70752

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5339afb
DataViews: Add groupByField support to grid layout
oandregal Jul 17, 2025
2ceb8b8
Update API to use view.sort.grouped instead
oandregal Jul 17, 2025
117f4c0
Enable all layouts to test that grouping is maintained
oandregal Jul 17, 2025
aeac8fc
Prepend field label in group separator
oandregal Jul 17, 2025
fef3502
Revert "Update API to use view.sort.grouped instead"
oandregal Jul 18, 2025
703aa6c
Sort by groupByField
oandregal Jul 18, 2025
5b8663f
Improve LLM generated code
oandregal Jul 18, 2025
1a733ad
Let "Type: value" be translated
oandregal Jul 21, 2025
d97929e
Document in readme
oandregal Jul 21, 2025
e2235dc
Update test data to latest
oandregal Jul 21, 2025
8ac0e2c
Use a Map instead of object to hold the groups
oandregal Jul 21, 2025
4aef87a
Add changelog
oandregal Jul 21, 2025
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
Prev Previous commit
Next Next commit
Revert "Update API to use view.sort.grouped instead" 
This reverts commit 90cb723.
  • Loading branch information
@oandregal
oandregal committed Jul 21, 2025
commit fef3502445c62ad4976eb433043155636a8b1bad
6 changes: 0 additions & 6 deletions packages/dataviews/src/components/dataviews-view-config/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,6 @@ function SortFieldControl() {
sort: {
direction: view?.sort?.direction || 'desc',
field: value,
...( view?.sort?.grouped && {
grouped: view.sort.grouped,
} ),
},
showLevels: false,
} );
Expand Down Expand Up @@ -194,9 +191,6 @@ function SortDirectionControl() {
( field ) => field.enableSorting !== false
)?.id ||
'',
...( view?.sort?.grouped && {
grouped: view.sort.grouped,
} ),
},
showLevels: false,
} );
Expand Down
6 changes: 1 addition & 5 deletions packages/dataviews/src/components/dataviews/stories/index.story.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,7 @@ export const GroupedGridLayout = () => {
titleField: 'title',
descriptionField: 'description',
mediaField: 'image',
sort: {
field: 'type',
direction: 'asc',
grouped: true,
},
groupByField: 'type',
layout: {
badgeFields: [ 'satellites' ],
},
Expand Down
11 changes: 6 additions & 5 deletions packages/dataviews/src/dataviews-layouts/grid/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,15 +294,16 @@ function ViewGrid< Item >( {
}
: {};

// Group data by sort.field if sort.grouped is true
const groupField = view.sort?.grouped
? fields.find( ( f ) => f.id === view.sort?.field )
const groupField = view.groupByField
? fields.find( ( f ) => f.id === view.groupByField )
: null;
const groupedData = view.sort?.grouped

// Group data by groupByField if specified
const groupedData = view.groupByField
? data.reduce( ( groups: { [ key: string ]: typeof data }, item ) => {
const groupValue = groupField?.getValue
? groupField.getValue( { item } )
: ( item as any )[ view.sort?.field! ];
: ( item as any )[ view.groupByField! ];
const key = String( groupValue ?? __( 'No group' ) );
if ( ! groups[ key ] ) {
groups[ key ] = [];
Expand Down
6 changes: 0 additions & 6 deletions packages/dataviews/src/dataviews-layouts/table/column-header-menu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,12 +143,6 @@ const _HeaderMenu = forwardRef( function HeaderMenu< Item >(
sort: {
field: fieldId,
direction,
...( view?.sort
?.grouped && {
grouped:
view.sort
.grouped,
} ),
},
showLevels: false,
} );
Expand Down
10 changes: 5 additions & 5 deletions packages/dataviews/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,11 +368,6 @@ interface ViewBase {
* The direction to sort by.
*/
direction: SortDirection;

/**
* Whether to group the data by this field.
*/
grouped?: boolean;
};

/**
Expand Down Expand Up @@ -424,6 +419,11 @@ interface ViewBase {
* Whether to show the hierarchical levels.
*/
showLevels?: boolean;

/**
* The field to group by.
*/
groupByField?: string;
Copy link
Contributor

@youknowriad youknowriad Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any thoughts on a UI to configure this? (not necessary for this PR)

Also would be good to document this in the README.

Copy link
Member Author

@oandregal oandregal Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done at d97929e

Copy link
Member Author

@oandregal oandregal Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any thoughts on a UI to configure this? (not necessary for this PR)

The obvious way is to add a new select in the view config somewhere. Alternatively, we could explore making it part of the field list (similarly to what we have for the media field).

}

export interface ColumnStyle {
Expand Down