From 22533addb634b5d4c03f65f8323af57374b73f31 Mon Sep 17 00:00:00 2001 From: Sycamore <71297412+samuelsycamore@users.noreply.github.com> Date: Wed, 22 Jan 2025 08:42:39 -0800 Subject: [PATCH] [docs] Revise planned feature callouts and descriptions (#16290) --- .../data-grid/column-groups/column-groups.md | 22 +++++++------------ docs/data/data-grid/pivoting/pivoting.md | 11 ++++------ .../data-grid/row-grouping/row-grouping.md | 9 +++----- .../data-grid/row-ordering/row-ordering.md | 19 ++++------------ .../server-side-data/lazy-loading.md | 9 +++----- .../date-range-picker/date-range-picker.md | 11 ++++------ .../time-range-picker/time-range-picker.md | 11 +++++----- 7 files changed, 31 insertions(+), 61 deletions(-) diff --git a/docs/data/data-grid/column-groups/column-groups.md b/docs/data/data-grid/column-groups/column-groups.md index 35f2c3cdb12cf..6eed93e8d48da 100644 --- a/docs/data/data-grid/column-groups/column-groups.md +++ b/docs/data/data-grid/column-groups/column-groups.md @@ -82,28 +82,22 @@ The demo below uses [`renderHeaderGroup`](/x/react-data-grid/column-groups/#cust ## Manage group visibility 🚧 -The column group should allow to switch between an extended/collapsed view which hide/show some columns. - :::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #6651](https://github.com/mui/mui-x/issues/6651) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This feature isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/6651) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: -## Column group ordering [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧 +With this feature, users would be able to expand and collapse grouped columns to toggle their visibility. -Users could drag and drop group header to move all the group children at once, [like they can already do it with normal columns](/x/react-data-grid/column-ordering/). +## Column group ordering [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧 :::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #9448](https://github.com/mui/mui-x/issues/9448) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This feature isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/9448) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: +With this feature, users would be able to drag and drop grouped headers to move all grouped children at once (which is [already possible for normal columns](/x/react-data-grid/column-ordering/)). + ## API - [DataGrid](/x/api/data-grid/data-grid/) diff --git a/docs/data/data-grid/pivoting/pivoting.md b/docs/data/data-grid/pivoting/pivoting.md index 08c6ca94735ba..c1bc5a1deb55c 100644 --- a/docs/data/data-grid/pivoting/pivoting.md +++ b/docs/data/data-grid/pivoting/pivoting.md @@ -4,17 +4,14 @@ title: Data Grid - Pivoting # Data Grid - Pivoting [](/x/introduction/licensing/#premium-plan 'Premium plan')🚧 -

Turn a column values into columns.

+

Rearrange columns and values to view data from multiple perspectives.

:::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #214](https://github.com/mui/mui-x/issues/214) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This feature isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/214) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: -Pivoting will allow you to take a columns values and turn them into columns. +With the pivoting feature, users would be able to turn a column into a row, transforming the column's values into new columns. ## API diff --git a/docs/data/data-grid/row-grouping/row-grouping.md b/docs/data/data-grid/row-grouping/row-grouping.md index 846c08b234395..099a896dde408 100644 --- a/docs/data/data-grid/row-grouping/row-grouping.md +++ b/docs/data/data-grid/row-grouping/row-grouping.md @@ -387,14 +387,11 @@ The `apiRef.current.getRowGroupChildren` method is not compatible with the [serv ## Row group panel 🚧 :::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #5235](https://github.com/mui/mui-x/issues/5235) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This feature isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/5235) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: -With this panel, your users will be able to control which columns are used for grouping just by dragging them inside the panel. +With the row group panel, users would be able to control which columns are used for grouping by dragging them inside the panel. ## Full example diff --git a/docs/data/data-grid/row-ordering/row-ordering.md b/docs/data/data-grid/row-ordering/row-ordering.md index b4cd6e75930f6..d529061218008 100644 --- a/docs/data/data-grid/row-ordering/row-ordering.md +++ b/docs/data/data-grid/row-ordering/row-ordering.md @@ -77,25 +77,14 @@ This approach can also be used to change the location of the toggle column. For now, row reordering is disabled if sorting is applied to the Data Grid. ::: -## Reordering rows with row grouping 🚧 +## Reordering with tree data and grouping 🚧 :::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #4821](https://github.com/mui/mui-x/issues/4821) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This feature isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/4821) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: -## Reordering rows with tree data 🚧 - -:::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #4821](https://github.com/mui/mui-x/issues/4821) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. -::: +With this feature, users would be able to reorder rows in use cases that also involve tree data and/or row grouping. ## API diff --git a/docs/data/data-grid/server-side-data/lazy-loading.md b/docs/data/data-grid/server-side-data/lazy-loading.md index 176ddeff29133..8ce52a3b75edc 100644 --- a/docs/data/data-grid/server-side-data/lazy-loading.md +++ b/docs/data/data-grid/server-side-data/lazy-loading.md @@ -94,14 +94,11 @@ The demo below serves as a showcase of the behavior described above, and is not ## Nested lazy loading 🚧 :::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #14527](https://github.com/mui/mui-x/issues/14527) if you want to see it land faster. - -Don't hesitate to leave a comment on the issue to help influence what gets built—especially if you already have a use case for this feature, or if you're facing a specific pain point with your current solution. +This feature isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/14527) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: -When completed, it will be possible to use the `unstable_lazyLoading` flag in combination with [tree data](/x/react-data-grid/server-side-data/tree-data/) and [row grouping](/x/react-data-grid/server-side-data/row-grouping/). +With this feature, you would be able to use the `unstable_lazyLoading` flag in use cases that also involve tree data and/or row grouping. ## Error handling diff --git a/docs/data/date-pickers/date-range-picker/date-range-picker.md b/docs/data/date-pickers/date-range-picker/date-range-picker.md index 227d9b971b183..68f5251fe34ac 100644 --- a/docs/data/date-pickers/date-range-picker/date-range-picker.md +++ b/docs/data/date-pickers/date-range-picker/date-range-picker.md @@ -114,12 +114,9 @@ See the [Validation](/x/react-date-pickers/validation/) documentation page for m ## Month Range Picker 🚧 -The Month Range Picker allows setting a range of months. - :::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #4995](https://github.com/mui/mui-x/issues/4995) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This component isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/4995) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: + +The Month Range Picker would let users select a range of months. diff --git a/docs/data/date-pickers/time-range-picker/time-range-picker.md b/docs/data/date-pickers/time-range-picker/time-range-picker.md index cc962ee37e99d..b54ff358d4c05 100644 --- a/docs/data/date-pickers/time-range-picker/time-range-picker.md +++ b/docs/data/date-pickers/time-range-picker/time-range-picker.md @@ -8,12 +8,11 @@ materialDesign: https://m2.material.io/components/date-pickers # Time Range Picker [](/x/introduction/licensing/#pro-plan 'Pro plan')🚧 -

The Time Range Picker lets the user select a range of time.

+

The Time Range Picker lets users select a range of time values.

:::warning -This feature isn't implemented yet. It's coming. - -👍 Upvote [issue #4460](https://github.com/mui/mui-x/issues/4460) if you want to see it land faster. - -Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution. +This component isn't available yet, but it is planned—you can 👍 upvote [this GitHub issue](https://github.com/mui/mui-x/issues/4460) to help us prioritize it. +Please don't hesitate to leave a comment there to describe your needs, especially if you have a use case we should address or you're facing specific pain points with your current solution. ::: + +The Time Range Picker would let users select a range of time values.