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.

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

[docs] Document grouping, aggregation within the pro plan #3453

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

bharatkashyap
Copy link
Member

@bharatkashyap bharatkashyap added the docs Improvements or additions to the documentation label Apr 25, 2024
@bharatkashyap bharatkashyap changed the title [docs] Document grouping and aggregation features within the pro plan [docs] Document grouping, aggregation within the pro plan Apr 25, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 25, 2024
Feature which allows you to configure grouping and aggregation features on the data grid through visual controls. Read more about this feature on the [data grid](/toolpad/studio/components/data-grid/#grouping-and-aggregating-pro) page.

:::info
The following Pro features are included with an [X Premium license](https://mui.com/x/introduction/licensing/#premium-plan):
Copy link
Member

Choose a reason for hiding this comment

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

This is not implemented at the moment

Copy link
Member

Choose a reason for hiding this comment

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

I think we should remove the info section from here and instead let users read everything about grouping and aggregation from the data grid page, as suggested here: https://github.com/mui/mui-toolpad/pull/3453/files#r1580645306

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll create an issue asking for upvotes about whether we should make the aggregating and grouping feature auto-available in the built-in data grid if a user already has an X Premium license.

#3481

@@ -26,10 +26,19 @@ const COLUMNS = [
{ field: 'Location', type: 'string' },
];

export default function BasicDataGrid() {
export default function ProDataGrid() {
Copy link
Member

Choose a reason for hiding this comment

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

I'm merging #3441 first which corrects the naming of this file and component.

…branch 'master' of github.com:mui/mui-toolpad into fix/pro-docs
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 26, 2024
### Grouping and aggregating (Pro)

When you use the Toolpad [pro plan](/toolpad/studio/getting-started/roadmap/#pro-plan), the DataGrid gains grouping and aggregating capabilities. You can turn this off for individual columns.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If you have [X Premium license](https://mui.com/x/introduction/licensing/#premium-plan), then you can use this feature inside Toolpad Studio through a custom component. Check out this [example](https://github.com/mui/mui-toolpad/tree/master/examples/datagrid-premium) for more.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation PR: out-of-date The pull request has merge conflicts and can't be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Communicate filterable/aggregable columns as pro feature
3 participants