diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d1d58f9a6cf..e874c463a765 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -94,7 +94,7 @@ We'd like to offer a big thanks to the 12 contributors who made this release pos โš  Users relying on the old API (legacy) don't need to worry as it will continue to work until v6. The new API also features brand new documentation with more useful demos and guides explaining how to create custom edit components. - Visit the new [documentation](https://mui.com/components/data-grid/editing/) for more information. + Visit the new [documentation](https://mui.com/x/react-data-grid/editing/) for more information. - ๐Ÿ“š Documentation improvements - ๐Ÿž Bug and typo fixes @@ -159,7 +159,7 @@ We'd like to offer a big thanks to the 8 contributors who made this release poss ({ top: 10, bottom: 10 })} /> ``` - Check the [documentation](https://mui.com/components/data-grid/rows/#row-spacing) for more information. + Check the [documentation](https://mui.com/x/react-data-grid/rows/#row-spacing) for more information. ### `@mui/x-data-grid@v5.6.1` / `@mui/x-data-grid-pro@v5.6.1` @@ -322,7 +322,7 @@ A big thanks to the 6 contributors who made this release possible. Here are some /> ``` - Check the [documentation](https://mui.com/components/data-grid/filtering/#customize-the-filter-panel-content) to see all available props. + Check the [documentation](https://mui.com/x/react-data-grid/filtering/#customize-the-filter-panel-content) to see all available props. - ๐Ÿ“š Documentation improvements - ๐Ÿž Bugfixes @@ -361,7 +361,7 @@ _Feb 3, 2022_ A big thanks to the 10 contributors who made this release possible. Here are some highlights โœจ: -- ๐ŸŽ Add support for [master/detail](https://mui.com/components/data-grid/group-pivot/#master-detail) (#3387) @m4theushw +- ๐ŸŽ Add support for [master/detail](https://mui.com/x/react-data-grid/group-pivot/#master-detail) (#3387) @m4theushw @@ -413,7 +413,7 @@ _Jan 28, 2022_ A big thanks to the 9 contributors who made this release possible. Here are some highlights โœจ: -- ๐Ÿšฃ Introduce [variable row height](https://mui.com/components/data-grid/rows/#variable-row-height) (#438) @DanailH +- ๐Ÿšฃ Introduce [variable row height](https://mui.com/x/react-data-grid/rows/#variable-row-height) (#438) @DanailH Allows for setting a row-specific height. By default, all rows have the same height, but now you can set the height on a per-row basis. @@ -422,7 +422,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some (id % 2 === 0 ? 100 : null)} /> ``` -- ๐ŸŽ Add new CSV export option: [`getRowsToExport`](https://mui.com/components/data-grid/export/#custom-exported-content) (#3687) @flaviendelangle +- ๐ŸŽ Add new CSV export option: [`getRowsToExport`](https://mui.com/x/react-data-grid/export/#custom-exported-content) (#3687) @flaviendelangle - ๐Ÿ“š Documentation improvements - ๐Ÿž Bugfixes @@ -504,7 +504,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some /> ``` - For more details see the [introduction blog post](https://mui.com/blog/introducing-the-row-grouping-feature/) and [documentation](https://mui.com/components/data-grid/group-pivot/#row-grouping). + For more details see the [introduction blog post](https://mui.com/blog/introducing-the-row-grouping-feature/) and [documentation](https://mui.com/x/react-data-grid/group-pivot/#row-grouping). - โšก Add `is any of` filter operator (#2874) @alexfauquette @@ -527,7 +527,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some To make the grid more flexible we added component slots for base `@mui/material` components that we use. Those component slots are prefixed with `Base` to differentiate them from the other grid specific components - For more information check the documentation [documentation](https://mui.com/api/data-grid/data-grid/#slots). + For more information check the documentation [documentation](https://mui.com/x/api/data-grid/data-grid/#slots). - ๐Ÿ”ฅ Allow to pass `csvOptions` and `printOptions` to `toolbar` component prop (#3623) @flaviendelangle @@ -558,7 +558,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some /> ``` - See the [documentation](https://mui.com/components/data-grid/columns/#column-visibility) for more details. + See the [documentation](https://mui.com/x/react-data-grid/columns/#column-visibility) for more details. The `hide` property from `GridColDef` still works but has been deprecated. @@ -606,7 +606,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some - [core] Add language to markdown code block (#3651) @m4theushw - [core] Add typing to the pre-processors methods (#3595) @flaviendelangle - [core] Don't bump peer dependency ranges on dependency updates (#3646) @oliviertassinari -- [core] Rename more instances of Material-UI to MUI (#3525) @oliviertassinari +- [core] Rename more instances of Material UI to MUI (#3525) @oliviertassinari - [core] Renovate should not try to update node (#3645) @oliviertassinari - [core] Report performance test results on each PR (#3551) @m4theushw - [core] Update monorepo (#3653) @m4theushw @@ -714,7 +714,7 @@ A big thanks to the 5 contributors who made this release possible. Here are some ### `@mui/x-data-grid@v5.2.0` / `@mui/x-data-grid-pro@v5.2.0` -- ๐Ÿš€ Introduce the [column pinning](https://mui.com/components/data-grid/columns/#column-pinning) feature (#2946) @m4theushw +- ๐Ÿš€ Introduce the [column pinning](https://mui.com/x/react-data-grid/columns/#column-pinning) feature (#2946) @m4theushw @@ -794,7 +794,7 @@ A big thanks to the 11 contributors who made this release possible. Here are som ### `@mui/x-data-grid@v5.1.0` / `@mui/x-data-grid-pro@v5.1.0` -- ๐Ÿš€ Introduce the [tree data](https://mui.com/components/data-grid/group-pivot/#tree-data) feature (#2725) @flaviendelangle +- ๐Ÿš€ Introduce the [tree data](https://mui.com/x/react-data-grid/group-pivot/#tree-data) feature (#2725) @flaviendelangle @@ -939,8 +939,8 @@ _Nov 23, 2021_ ๐ŸŽ‰ We are excited to introduce [MUI X v5.0.0](https://mui.com/blog/mui-x-v5/) ๐ŸŽ‰! -If you want to migrate the DataGrid or DataGridPro from v4 to v5, take a look at the [migration guide](https://mui.com/components/data-grid/migration-v4/). -This version is fully compatible with `@mui/material@5.X` and can be used with `@material-ui/core@4.x` with some [additional steps](https://mui.com/components/data-grid/migration-v4/#using-mui-x-v5-with-mui-core-v4). +If you want to migrate the DataGrid or DataGridPro from v4 to v5, take a look at the [migration guide](https://mui.com/x/react-data-grid/migration-v4/). +This version is fully compatible with `@mui/material@5.X` and can be used with `@material-ui/core@4.x` with some [additional steps](https://mui.com/x/react-data-grid/migration-v4/#using-mui-x-v5-with-mui-core-v4). A big thanks to the 7 contributors who made this release possible. Here are some highlights โœจ: @@ -1341,7 +1341,7 @@ A big thanks to the 7 contributors who made this release possible. Here are some - ๐ŸŽ Add the ability to print the grid (#2519) @DanailH - This new feature adds a button to the toolbar to generate a printer-friendly layout. Check the [documentation](https://mui.com/components/data-grid/export/#print) about it. + This new feature adds a button to the toolbar to generate a printer-friendly layout. Check the [documentation](https://mui.com/x/react-data-grid/export/#print) about it. - ๐Ÿ’ก Enhance internal code structure - โœจ New slots for `row` and `cell` (#2753) @m4theushw @@ -1366,7 +1366,7 @@ A big thanks to the 7 contributors who made this release possible. Here are some - `onRowEnter` - `onRowLeave` - For more information, check [this page](https://mui.com/components/data-grid/components/#row). Example: + For more information, check [this page](https://mui.com/x/react-data-grid/components/#row). Example: ```diff -; @@ -1668,7 +1668,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some - ๐Ÿ“š Migrate to the new documentation infrastructure and design (#2441) (@DanailH, @m4theushw) - ๐ŸŽ Add `actions` column type (#2385) @m4theushw - See the documentation for [more details](https://mui.com/components/data-grid/columns/#column-types). + See the documentation for [more details](https://mui.com/x/react-data-grid/columns/#column-types). - ๐Ÿ‘ Allow to disable virtualization with the `disableVirtualization` prop (#2326) @m4theushw - ๐Ÿš€ Introduce the new `isRowSelected` api method (#2523) @flaviendelangle @@ -1786,14 +1786,14 @@ _Aug 27, 2021_ ๐ŸŽ‰ This is the first stable release of the data grid component ๐ŸŽ‰! -We have been iterating on the component for [18 months](https://github.com/mui/mui-x/commit/705cb0f387b5f3aa056bf40c4183a2342b317447). With the introduction of the [row edit](https://mui.com/components/data-grid/editing/#row-editing) feature, many bug fixes, and polishing of the documentation, we believe the component is ready for a stable release. +We have been iterating on the component for [18 months](https://github.com/mui/mui-x/commit/705cb0f387b5f3aa056bf40c4183a2342b317447). With the introduction of the [row edit](https://mui.com/x/react-data-grid/editing/#row-editing) feature, many bug fixes, and polishing of the documentation, we believe the component is ready for a stable release. The MUI X v4.0.0 release supports [MUI Core](https://github.com/mui/material-ui) v4 and has partial support for v5-beta. With the soon-to-be-released v5 version of the core components, we are moving ongoing work to the v5 release line (Core and X). The support for existing projects on MUI v4 won't be a priority going forward. We encourage you to migrate to MUI Core v5-beta and soon MUI X v5-beta. We don't patch, fix, or alter older versions. Using MUI Core v4 with MUI X v5 might lead to extra bundle size and configuration. A big thanks to the 6 contributors who made this release possible. Here are some highlights โœจ: -- ๐Ÿš€ Introduce the [row editing](https://mui.com/components/data-grid/editing/#row-editing) feature (#2098) @m4theushw +- ๐Ÿš€ Introduce the [row editing](https://mui.com/x/react-data-grid/editing/#row-editing) feature (#2098) @m4theushw @@ -1804,7 +1804,7 @@ A big thanks to the 6 contributors who made this release possible. Here are some - โœจ Rename the `@material-ui` npm scope to `@mui` (#2341) @oliviertassinari - This is part of the ongoing rebranding of the project and company. Material-UI is our current official name, however, we are going to change it. It's too long to write, read, and pronounce; and it is too closely associated with Material Design. In the near future, the whole project/company is moving to MUI and https://mui.com/. + This is part of the ongoing rebranding of the project and company. Material UI is our current official name, however, we are going to change it. It's too long to write, read, and pronounce; and it is too closely associated with Material Design. In the near future, the whole project/company is moving to MUI and https://mui.com/. - ๐Ÿ’ก The `api` property was removed from the callback params. To access the API, use the `DataGridPro` (#2312) @DanailH @@ -1962,7 +1962,7 @@ Big thanks to the 6 contributors who made this release possible. Here are some h ``` - [XGrid] The `setEditCellProps` API call is not available anymore. - Use the [controlled editing](https://mui.com/components/data-grid/editing/#controlled-editing) or `setEditRowsModel`. + Use the [controlled editing](https://mui.com/x/react-data-grid/editing/#controlled-editing) or `setEditRowsModel`. ```diff -apiRef.current.setEditCellProps({ id, field, props: { ...props, error: true } }); @@ -2048,7 +2048,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h - [DataGrid] Improve controllable pagination (#2099) @flaviendelangle - - The `pageSize` is now a controlled prop. If you set a value, you also need to handle updates with onPageSizeChange. See [the documentation](https://mui.com/components/data-grid/pagination/#page-size). + - The `pageSize` is now a controlled prop. If you set a value, you also need to handle updates with onPageSizeChange. See [the documentation](https://mui.com/x/react-data-grid/pagination/#page-size). - Change the controllable API signature: ```diff @@ -2294,7 +2294,7 @@ Big thanks to the 6 contributors who made this release possible. Here are some h - ๐Ÿ› We have fixed the `Select all` checkbox. When triggered, it should only select the filtered rows (#1879) @ZeeshanTamboli - โšก๏ธ We have added a new `singleSelect` column type (#1956) @DanailH - Using the column `type: 'singleSelect'` defaults to `Select` component when the cell is in `edit` mode. You can find the documentation [following this link](https://mui.com/components/data-grid/columns/#column-types). + Using the column `type: 'singleSelect'` defaults to `Select` component when the cell is in `edit` mode. You can find the documentation [following this link](https://mui.com/x/react-data-grid/columns/#column-types). ```jsx CTRL + click (#1813) @ZeeshanTamboli - โšก๏ธ Refactor scroll size detector (#1703) @dtassone -- ๐Ÿ“– Add [documentation](https://mui.com/api/data-grid/) for interfaces and events (#1529) @m4theushw +- ๐Ÿ“– Add [documentation](https://mui.com/x/api/data-grid/) for interfaces and events (#1529) @m4theushw - ๐Ÿž Bugfixes ### @material-ui/x-grid@v4.0.0-alpha.31 / @material-ui/data-grid@v4.0.0-alpha.31 @@ -2650,7 +2650,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h - [core] Batch updates of storybook (#1751) @oliviertassinari - [core] Help support different documents (#1754) @oliviertassinari -- [core] Upgrade Material-UI core v5 to latest version (#1763) @ZeeshanTamboli +- [core] Upgrade MUI Core v5 to latest version (#1763) @ZeeshanTamboli - [test] Reduce flakiness (#1753) @oliviertassinari - [test] Remove skip on Edge (#1708) @m4theushw @@ -2664,7 +2664,7 @@ Big thanks to the 11 contributors who made this release possible. Here are some - ๐Ÿ’… Add `columnHeader`, `row` and `cell` to the `classes` prop (#1660) @DanailH - โœ… Add the `isRowSelectable` prop to disable selection on certain rows (#1659) @m4theushw - See the documentation for [more details](https://mui.com/components/data-grid/selection/#disable-selection-on-certain-rows). + See the documentation for [more details](https://mui.com/x/react-data-grid/selection/#disable-selection-on-certain-rows). - โšก๏ธ Add new icon slot to be displayed when the column is unsorted (#1415) @m4theushw - โš™ Improve consistency of the API to prepare for the first beta release @@ -2736,7 +2736,7 @@ Big thanks to the 11 contributors who made this release possible. Here are some - [DataGrid] Add `isRowSelectable` prop (#1659) @m4theushw - [DataGrid] Add sort icon for when column is unsorted (#1415) @m4theushw - [DataGrid] Fix `id` and `aria-labelledby` attributes on the column menu (#1460) @m4theushw -- [DataGrid] Fix broken checkbox in Material-UI v5 (#1587) @ZeeshanTamboli +- [DataGrid] Fix broken checkbox in Material UI v5 (#1587) @ZeeshanTamboli - [DataGrid] Fix CSS classes prefix (#1693) @m4theushw - [DataGrid] Fix German (de-DE) locale (#1624) @klinge27 - [DataGrid] Fix filter with object as value and value getter (#1665) @dtassone @@ -2912,7 +2912,7 @@ Big thanks to the 7 contributors who made this release possible. Here are some h - ๐Ÿ’„ Release the cell editing feature (#1287) @dtassone - This is the first release of the Cell editing feature. You can find the documentation [following this link](https://mui.com/components/data-grid/editing/#cell-editing). We have spent the last three months working on it. + This is the first release of the Cell editing feature. You can find the documentation [following this link](https://mui.com/x/react-data-grid/editing/#cell-editing). We have spent the last three months working on it. ![cell edit](https://user-images.githubusercontent.com/3165635/115632215-87994700-a307-11eb-91d9-9f5537df0911.gif) @@ -3039,7 +3039,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h - [DataGrid] Rename `useGridBaseComponentProps` hook to `useGridSlotComponentProps` (#1252) @DanailH - [DataGrid] Rename modules (#1292) @DanailH - [DataGrid] Rename all events related to column reordering, e.g. `GRID_COL_REORDER_START` -> `GRID_COLUMN_REORDER_START` (#1299) @m4theushw -- [DataGrid] Methods `onColItemDragStart`, `onColHeaderDragOver`, `onColItemDragOver`, `onColItemDragEnter` removed from the grid API. Prefer listening to [column reordering events](https://mui.com/components/data-grid/columns/#column-reorder) (#1299) @m4theushw +- [DataGrid] Methods `onColItemDragStart`, `onColHeaderDragOver`, `onColItemDragOver`, `onColItemDragEnter` removed from the grid API. Prefer listening to [column reordering events](https://mui.com/x/react-data-grid/columns/#column-reorder) (#1299) @m4theushw - [DataGrid] Calling `apiRef.current.getColumnHeaderParams` returns a `GridColumnHeaderParams` instead of `GridColParams` (#1299) @m4theushw - [DataGrid] Events that follow the pattern `GRID_COLUMN_HEADER_xxx` will be called with a `GridColumnHeaderParams` instead of `GridColParams` (#1299) @m4theushw - [DataGrid] The `renderHeader` will be called with a `GridColumnHeaderParams` instead of `GridColParams` (#1299) @m4theushw @@ -3065,7 +3065,7 @@ Big thanks to the 7 contributors who made this release possible. Here are some h - ๐ŸŽ Add `onRowsScrollEnd` to support infinite loading (#1199) @DanailH This is an XGrid feature. Provides the ability to tap into the `onRowsScrollEnd` which is called when the scroll reaches the bottom of the grid viewport allowing developers to load additional data. It can be used with a combination of `scrollBottomThreshold` to control the area in which the `onRowsScrollEnd` is called. - See the documentation for [more details](https://mui.com/components/data-grid/rows/#infinite-loading). + See the documentation for [more details](https://mui.com/x/react-data-grid/rows/#infinite-loading). - ๐Ÿ•น Provide the ability to sort by multiple columns using Shift+click (#1203) @dtassone - ๐Ÿ‡ต๐Ÿ‡ฑ Added pl-PL locale (#1117) @LarsKumbier @@ -3137,7 +3137,7 @@ Big thanks to the 7 contributors who made this release possible. Here are some h - ๐ŸŽ Add support for CSV export (#1030) @DanailH. This is the first iteration of the feature. You can either render the `GridToolbarExport` component in the toolbar or use the apiRef `exportDataAsCsv`/`getDataAsCsv` methods. - See the documentation for [more details](https://mui.com/components/data-grid/export/#csv-export). + See the documentation for [more details](https://mui.com/x/react-data-grid/export/#csv-export). - ๐ŸŒ Improve the support for custom locales (#1096, #1079, #1109, #1077) - โ™ฟ๏ธ Fix a couple of accessibility issues with the popups (#1105, #1102) @@ -3146,8 +3146,8 @@ Big thanks to the 7 contributors who made this release possible. Here are some h #### Breaking changes -- [DataGrid] Prefix all public API to fit into the global Material-UI namespace (#1069) @DanailH - This change gets the data grid one step closer to a stable release. It allows the data grid to fit into the global namespace of Material-UI. All the exported modules should have a unique name. It allows the search features, in Google, in the docs, and in the codebase to work effectively and efficiently. +- [DataGrid] Prefix all public API to fit into the global Material UI namespace (#1069) @DanailH + This change gets the data grid one step closer to a stable release. It allows the data grid to fit into the global namespace of Material UI. All the exported modules should have a unique name. It allows the search features, in Google, in the docs, and in the codebase to work effectively and efficiently. For the mirgration, prefixing a broken import with "grid" is often enough. In the case it's not working, head to the pull request's description. It [details all the changes](https://github.com/mui/mui-x/pull/1069). @@ -3188,9 +3188,9 @@ _Feb 17, 2021_ Big thanks to the 4 contributors who made this release possible. Here are some highlights โœจ: - ๐Ÿ“ Add support for default locales (#983) @DanailH - We have built the infrastructure to support around 100 [default locales](https://mui.com/components/data-grid/localization/#supported-locales). If you have localized the data grid in your application. Please do consider contributing new translations back to Material-UI by opening a pull request. + We have built the infrastructure to support around 100 [default locales](https://mui.com/x/react-data-grid/localization/#supported-locales). If you have localized the data grid in your application. Please do consider contributing new translations back to Material UI by opening a pull request. - ๐ŸŽ Add new `selectionModel` prop (#986) @dtassone - The prop can be used to control the selected rows in the data grid. [See the docs](https://mui.com/components/data-grid/selection/#controlled-selection). + The prop can be used to control the selected rows in the data grid. [See the docs](https://mui.com/x/react-data-grid/selection/#controlled-selection). - ๐Ÿ’… Add support for default props from theme (#1019) @DanailH - ๐Ÿ™Œ Fix scrollbar size on windows (#1061) @dtassone - ๐Ÿ› Polish existing features, fix 9 issues. @@ -3229,7 +3229,7 @@ Big thanks to the 4 contributors who made this release possible. Here are some h ``` - [DataGrid] Change page index base, from 1 to 0. (#1021) @dtassone - This change is done for consistency with `TablePagination` and JavaScript arrays that are 0-based. Material-UI still uses a 1-base page for the `Pagination` component that matches the URL's query. + This change is done for consistency with `TablePagination` and JavaScript arrays that are 0-based. Material UI still uses a 1-base page for the `Pagination` component that matches the URL's query. ```diff -const [page, setPage] = React.useState(1); @@ -3319,9 +3319,9 @@ _Jan 26, 2021_ Big thanks to the 5 contributors who made this release possible. Here are some highlights โœจ: -- ๐ŸŽ Add support for Material-UI v5-alpha (#855) @DanailH. - The data grid supports Material-UI v4 and v5. We aim to retain the support for v4 as long as v5 hasn't reached the beta phase. -- ๐Ÿ’… Update the customization API to be closer to Material-UI v5. +- ๐ŸŽ Add support for Material UI v5-alpha (#855) @DanailH. + The data grid supports Material UI v4 and v5. We aim to retain the support for v4 as long as v5 hasn't reached the beta phase. +- ๐Ÿ’… Update the customization API to be closer to Material UI v5. The data grid accepts two props: `components` and `componentsProps`. The first prop allows to swapping specific components used in slots the grid, like the checkboxes. The second one allows providing extra props to each slot. It avoids the need for using the React context to access information from outside the data grid. @@ -3334,9 +3334,9 @@ Big thanks to the 5 contributors who made this release possible. Here are some h #### Breaking changes -- [DataGrid] Implement customization pattern of Material-UI v5 (#851, #879) @dtassone +- [DataGrid] Implement customization pattern of Material UI v5 (#851, #879) @dtassone - - Capitalize the keys of the `components` prop. This change aims to bring consistency with the customization pattern of Material-UI v5: + - Capitalize the keys of the `components` prop. This change aims to bring consistency with the customization pattern of Material UI v5: ```diff ``` - - Move all the icon components overrides in the `components` prop. And added the suffix 'Icon' on each icon component. This change aims to bring consistency with the customization pattern of Material-UI v5: + - Move all the icon components overrides in the `components` prop. And added the suffix 'Icon' on each icon component. This change aims to bring consistency with the customization pattern of Material UI v5: ```diff Shift + Space keyboard regression to select row (#897) @dtassone @@ -3407,7 +3407,7 @@ _Jan 14, 2021_ Big thanks to the 4 contributors who made this release possible. Here are some highlights โœจ: - ๐ŸŽ› Add support for Column selector (#837) @DanailH @dtassone. - The feature can be triggered from the toolbar or the column menu. Check [the documentation](https://mui.com/components/data-grid/columns/#column-selector). + The feature can be triggered from the toolbar or the column menu. Check [the documentation](https://mui.com/x/react-data-grid/columns/#column-selector). ![column selector](https://user-images.githubusercontent.com/3165635/104791267-6ff77300-579a-11eb-9338-11a8fde83258.gif) @@ -3462,11 +3462,11 @@ Big thanks to the 5 contributors who made this release possible. Here are some h - ๐ŸŒŽ Add support for internationalization (#718) @DanailH You can use the `localeText` prop to provide custom wordings in the data grid. - Check the documentation for [a demo](https://mui.com/components/data-grid/localization/#translation-keys). + Check the documentation for [a demo](https://mui.com/x/react-data-grid/localization/#translation-keys). - ๐Ÿ“š Start documenting the filtering feature ๐Ÿงช (#754) @dtassone - The work in progress filtering feature and documentation can be found following [this link](https://mui.com/components/data-grid/filtering/). Early feedback are welcome. + The work in progress filtering feature and documentation can be found following [this link](https://mui.com/x/react-data-grid/filtering/). Early feedback are welcome. ### @material-ui/x-grid@v4.0.0-alpha.14 / @material-ui/data-grid@v4.0.0-alpha.14 @@ -3522,7 +3522,7 @@ _Dec 9, 2020_ Big thanks to the 6 contributors who made this release possible. Here are some highlights โœจ: -- ๐Ÿ” Add a new data grid [density selector](https://mui.com/components/data-grid/rendering/#density) feature (#606) @DanailH. +- ๐Ÿ” Add a new data grid [density selector](https://mui.com/x/react-data-grid/rendering/#density) feature (#606) @DanailH. - ๐Ÿ’„ A first iteration on the data grid's toolbar. - ๐Ÿงช Continue the iteration on the data grid filtering feature, soon to be released @dtassone. @@ -3609,7 +3609,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h - [core] Remove gitHead (#669) @oliviertassinari - [core] Remove react-select (#658) @dependabot-preview - [core] Replace Storybook knobs for args (#601) @tooppaaa -- [core] Update to Material-UI v4.11.1 (#636) @oliviertassinari +- [core] Update to Material UI v4.11.1 (#636) @oliviertassinari ## [4.0.0-alpha.10](https://github.com/mui/mui-x/compare/v4.0.0-alpha.9...v4.0.0-alpha.10) @@ -3746,7 +3746,7 @@ _Sep 17, 2020_ This is the first public alpha release of the component after 6 months of development since the initial commit (March 15th 2020). `@material-ui/data-grid` is licensed under MIT while `@material-ui/x-grid` is licensed under a commercial license. -You can find the documentation at this address: https://mui.com/components/data-grid/. +You can find the documentation at this address: https://mui.com/x/react-data-grid/. ### @material-ui/x-grid@v4.0.0-alpha.1 / @material-ui/data-grid@v4.0.0-alpha.1 diff --git a/README.md b/README.md index 066af2ce9a1a..0d27c3c0fa2a 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,8 @@ We provide three options: ## Components -- [DataGrid](https://mui.com/components/data-grid/), published under `@mui/x-data-grid`, MIT licensed. -- [DataGridPro](https://mui.com/components/data-grid/#commercial-version), published under `@mui/x-data-grid-pro`, commercially licensed. +- [DataGrid](https://mui.com/x/react-data-grid/), published under `@mui/x-data-grid`, MIT licensed. +- [DataGridPro](https://mui.com/x/react-data-grid/#commercial-version), published under `@mui/x-data-grid-pro`, commercially licensed. ## Questions diff --git a/benchmark/package.json b/benchmark/package.json index ab98c20070c9..cd7b3cb02dcf 100644 --- a/benchmark/package.json +++ b/benchmark/package.json @@ -25,7 +25,7 @@ "react-virtualized": "^9.22.3", "serve-handler": "^6.1.3", "style-loader": "^3.3.1", - "webpack": "^5.70.0", + "webpack": "^5.71.0", "webpack-cli": "^4.9.2" } } diff --git a/docs/data/data-grid/accessibility/accessibility.md b/docs/data/data-grid/accessibility/accessibility.md index 850131307e21..ff56a953ad3f 100644 --- a/docs/data/data-grid/accessibility/accessibility.md +++ b/docs/data/data-grid/accessibility/accessibility.md @@ -103,5 +103,5 @@ On macOS: ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/columns/columns.md b/docs/data/data-grid/columns/columns.md index 95155371f841..4a9ea960e73e 100644 --- a/docs/data/data-grid/columns/columns.md +++ b/docs/data/data-grid/columns/columns.md @@ -127,7 +127,7 @@ The value generated is used for filtering, sorting, rendering, etc. unless overr The value setter is to be used when editing rows and it is the counterpart of the value getter. This enables you to customize how the entered value is stored in the row. A common use case for it is when the data is a nested structure. -Refer to the [cell editing](/components/data-grid/editing/#saving-nested-structures) documentation to see an example using it. +Refer to the [cell editing](/x/react-data-grid/editing/#saving-nested-structures) documentation to see an example using it. ```tsx function setFullName(params: GridValueSetterParams) { @@ -158,13 +158,13 @@ In the following demo, a formatter is used to display the tax rate's decimal val The value generated is only used for rendering purposes. Filtering and sorting do not rely on the formatted value. -Use the [`valueParser`](/components/data-grid/columns/#value-parser) to support filtering. +Use the [`valueParser`](/x/react-data-grid/columns/#value-parser) to support filtering. ### Value parser The value parser allows you to convert the user-entered value to another one used for filtering or editing. Common use cases include parsing date strings to JavaScript `Date` objects or formatted numbers (e.g. "1,000.50") into `Number`. -It can be understood as the inverse of [`valueFormatter`](/components/data-grid/columns/#value-formatter). +It can be understood as the inverse of [`valueFormatter`](/x/react-data-grid/columns/#value-formatter). In the following demo, the tax rate is displayed as a percentage (e.g. 20%) but a decimal number is used as value (e.g. 0.2). @@ -207,17 +207,17 @@ const columns: GridColDef[] = [ {{"demo": "RenderCellGrid.js", "bg": "inline"}} -**Note**: It is recommended to also set a `valueFormatter` providing a representation for the value to be used when [exporting](/components/data-grid/export/#exported-cells) the data. +**Note**: It is recommended to also set a `valueFormatter` providing a representation for the value to be used when [exporting](/x/react-data-grid/export/#exported-cells) the data. > โš ๏ธ When using `renderCell` with object cell values -> remember to handle [sorting](/components/data-grid/sorting/#custom-comparator). +> remember to handle [sorting](/x/react-data-grid/sorting/#custom-comparator). > Otherwise, sorting won't work. #### Render edit cell The `renderCell` render function allows customizing the rendered in "view mode" only. For the "edit mode", set the `renderEditCell` function to customize the edit component. -Check the [editing page](/components/data-grid/editing/) for more details about editing. +Check the [editing page](/x/react-data-grid/editing/) for more details about editing. #### Expand cell renderer @@ -253,11 +253,11 @@ const columns: GridColDef[] = [ ### Styling header -You can check the [styling header](/components/data-grid/style/#styling-column-headers) section for more information. +You can check the [styling header](/x/react-data-grid/style/#styling-column-headers) section for more information. ### Styling cells -You can check the [styling cells](/components/data-grid/style/#styling-cells) section for more information. +You can check the [styling cells](/x/react-data-grid/style/#styling-cells) section for more information. ## Column types @@ -447,9 +447,9 @@ They can be pinned either to the left or right side and cannot be reordered. To pin a column, there are a few ways: - Using the `initialState` prop -- [Controlling](/components/data-grid/columns/#controlling-the-pinned-columns) the `pinnedColumns` and `onPinnedColumnsChange` props +- [Controlling](/x/react-data-grid/columns/#controlling-the-pinned-columns) the `pinnedColumns` and `onPinnedColumnsChange` props - Dedicated buttons in the column menu -- Accessing the [imperative](/components/data-grid/columns/#apiref) API +- Accessing the [imperative](/x/react-data-grid/columns/#apiref) API To set pinned columns via `initialState`, pass an object with the following shape to this prop: @@ -542,9 +542,9 @@ Those selectors consider all the defined columns, including hidden ones. {{"demo": "ColumnsSelectorsNoSnap.js", "bg": "inline", "hideToolbar": true}} -More information about the selectors and how to use them on the [dedicated page](/components/data-grid/state/#access-the-state). +More information about the selectors and how to use them on the [dedicated page](/x/react-data-grid/state/#access-the-state). ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/components/components.md b/docs/data/data-grid/components/components.md index e115d3fe8095..bdc145dce8b6 100644 --- a/docs/data/data-grid/components/components.md +++ b/docs/data/data-grid/components/components.md @@ -9,7 +9,7 @@ title: Data Grid - Components ## Overriding components As part of the customization API, the grid allows you to override internal components with the `components` prop. -The prop accepts an object of type [`GridSlotsComponent`](/api/data-grid/data-grid/#slots). +The prop accepts an object of type [`GridSlotsComponent`](/x/api/data-grid/data-grid/#slots). If you wish to pass additional props in a component slot, you can do it using the `componentsProps` prop. This prop is of type `GridSlotsComponentsProps`. @@ -40,7 +40,7 @@ They can be used as below: - `useGridApiContext`: returns the `apiRef`. - `useGridSelector`: returns the result of a selector on the current state. -More details about the selectors in the [State page](/components/data-grid/state/#access-the-state) +More details about the selectors in the [State page](/x/react-data-grid/state/#access-the-state) ```tsx function CustomPagination() { @@ -60,7 +60,7 @@ function CustomPagination() { ## Components -The full list of overridable components can be found on the [`GridSlotsComponent`](/api/data-grid/data-grid/#slots) API page. +The full list of overridable components can be found on the [`GridSlotsComponent`](/x/api/data-grid/data-grid/#slots) API page. ### Column menu @@ -125,8 +125,8 @@ The grid exposes props to hide specific elements of the UI: ### Pagination -By default, pagination uses the [TablePagination](/components/pagination/#table-pagination) component that is optimized for handling tabular data. -This demo replaces it with the [Pagination](/components/pagination/) component. +By default, pagination uses the [TablePagination](/material-ui/react-pagination/#table-pagination) component that is optimized for handling tabular data. +This demo replaces it with the [Pagination](/material-ui/react-pagination/) component. {{"demo": "CustomPaginationGrid.js", "bg": "inline"}} @@ -148,7 +148,7 @@ In the following demo, an illustration is added on top of the default "No Rows" ### Row The `componentsProps.row` prop can be used to pass additional props to the row component. -One common use case might be to listen for events not exposed by [default](/components/data-grid/events/#catalog-of-events). +One common use case might be to listen for events not exposed by [default](/x/react-data-grid/events/#catalog-of-events). The demo below shows a context menu when a row is right-clicked. {{"demo": "RowContextMenu.js", "bg": "inline"}} @@ -168,5 +168,5 @@ As any component slot, every icon can be customized. However, it is not yet poss ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/demo/demo.md b/docs/data/data-grid/demo/demo.md index 1f3f82f28822..3b226bd583f7 100644 --- a/docs/data/data-grid/demo/demo.md +++ b/docs/data/data-grid/demo/demo.md @@ -10,5 +10,5 @@ title: Data Grid - Demo ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/editing-legacy/editing.md b/docs/data/data-grid/editing-legacy/editing.md index 82445a2f3ddd..8e4b8c6eb95a 100644 --- a/docs/data/data-grid/editing-legacy/editing.md +++ b/docs/data/data-grid/editing-legacy/editing.md @@ -73,11 +73,11 @@ The following demo shows how these two functions can be used: {{"demo": "ValueGetterSetterGrid.js", "bg": "inline"}} > Calling the `valueSetter` is the last step in the saving process. -> The [validation](/components/data-grid/editing/#client-side-validation) will still be called with the values before they pass through the setter. +> The [validation](/x/react-data-grid/editing/#client-side-validation) will still be called with the values before they pass through the setter. ### Client-side validation -To validate the value of a cell, add the `preProcessEditCellProps` callback to the [column definition](/api/data-grid/grid-col-def/) of the field you wish to validate. +To validate the value of a cell, add the `preProcessEditCellProps` callback to the [column definition](/x/api/data-grid/grid-col-def/) of the field you wish to validate. Once it is called, you can validate the value provided in `params.props.value`. Then, return a new object containing `params.props` along with `error` attribute set to true or false. If the `error` attribute is true, the value will never be committed. @@ -143,7 +143,7 @@ The demo lets you edit the ratings by double-clicking the cell. ### Edit using external button [](https://mui.com/store/items/material-ui-pro/) -You can override the default [start editing](#start-editing) triggers using the [`event.defaultMuiPrevented`](/components/data-grid/events/#disabling-the-default-behavior) on the synthetic React events. +You can override the default [start editing](#start-editing) triggers using the [`event.defaultMuiPrevented`](/x/react-data-grid/events/#disabling-the-default-behavior) on the synthetic React events. {{"demo": "StartEditButtonGrid.js", "bg": "inline", "disableAd": true}} @@ -166,7 +166,7 @@ The demo shows how to catch the start and end edit events in order to log which ## Row editing Row editing lets you edit all cells in a given row simultaneously. -It supports most of the same features as those available for [cell editing](/components/data-grid/editing/#cell-editing). +It supports most of the same features as those available for [cell editing](/x/react-data-grid/editing/#cell-editing). To enable it, change the edit mode to `"row"` using the `editMode` prop, then set to `true` the `editable` property in the `GridColDef` object of those columns that should be editable. ```tsx @@ -211,7 +211,7 @@ You can handle the `onEditRowsModelChange` callback to control the `GridEditRows ### Conditional validation [](https://mui.com/store/items/material-ui-pro/) Having all cells of a row in edit mode allows validating a field based on the value of another one -To do this, you will first need to add a `preProcessEditCellProps` callback to the [column definition](/api/data-grid/grid-col-def/). +To do this, you will first need to add a `preProcessEditCellProps` callback to the [column definition](/x/api/data-grid/grid-col-def/). When all cells in a row are in edit mode, you can validate fields by comparing their values. Return a new object contaning `params.props` and the `error` attribute with the validation status. Once at the least one field has the `error` attribute equals to true no new value will be committed. @@ -231,7 +231,7 @@ The following demo requires a value for the **Payment method** column if the **I ### Control with external buttons [](https://mui.com/store/items/material-ui-pro/) -You can [disable the default behavior](/components/data-grid/events/#disabling-the-default-behavior) of the grid and control the row edit using external buttons. +You can [disable the default behavior](/x/react-data-grid/events/#disabling-the-default-behavior) of the grid and control the row edit using external buttons. Here is how you can create a full-featured CRUD: @@ -240,7 +240,7 @@ Here is how you can create a full-featured CRUD: ### Saving rows with nested structures You can save columns that make use of `valueGetter` by adding a `valueSetter`. -The same [approach](/components/data-grid/editing/#saving-nested-structures) from the cell editing mode can be used here. +The same [approach](/x/react-data-grid/editing/#saving-nested-structures) from the cell editing mode can be used here. Note that the `valueSetter` will be called for each field. ### Server-side persistence [](https://mui.com/store/items/material-ui-pro/) @@ -270,5 +270,5 @@ You can import the following events to customize the editing experience: ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/editing/editing.md b/docs/data/data-grid/editing/editing.md index 2dc65c416eef..cc60e10778fb 100644 --- a/docs/data/data-grid/editing/editing.md +++ b/docs/data/data-grid/editing/editing.md @@ -16,13 +16,13 @@ title: Data Grid - Editing > This additional step is required because the default editing API has a couple of issues that can only be fixed with breaking changes, that will only be possible in v6. > To avoid having to wait for the next major release window, all breaking changes needed were included inside this flag. > -> If you are looking for the documentation for the default editing API, visit [this page](/components/data-grid/editing-legacy/). +> If you are looking for the documentation for the default editing API, visit [this page](/x/react-data-grid/editing-legacy/). > Note that it is encouraged to migrate to the new editing API since it will be enabled by default in v6. > Although it says "experimental," you can consider it stable. ## Making a column editable -You can make a column editable by enabling the `editable` property in its [column definition](/api/data-grid/grid-col-def/): +You can make a column editable by enabling the `editable` property in its [column definition](/x/api/data-grid/grid-col-def/): ```tsx @@ -96,7 +96,7 @@ When a cell is in edit mode, the user can stop editing with any of the following The `editable` property controls which cells are editable at the column level. You can use the `isCellEditable` callback prop to define which individual cells the user can edit in a given row. -It is called with a [`GridCellParams`](/api/data-grid/grid-cell-params/) object and must return `true` if the cell is editable, or `false` if not. +It is called with a [`GridCellParams`](/x/api/data-grid/grid-cell-params/) object and must return `true` if the cell is editable, or `false` if not. In the following demo, only the rows with an even `Age` value are editable. The editable cells have a green background for better visibility. @@ -140,7 +140,7 @@ The `valueParser` capitalizes the value entered, and the `valueSetter` splits th ## Events -The mouse and keyboard interactions that [start](#start-editing) and [stop](#stop-editing) cell editing do so by triggering the `'cellEditStart'` and `'cellEditStop'` [events](/components/data-grid/events/), respectively. +The mouse and keyboard interactions that [start](#start-editing) and [stop](#stop-editing) cell editing do so by triggering the `'cellEditStart'` and `'cellEditStop'` [events](/x/react-data-grid/events/), respectively. For row editing, the events are `'rowEditStart'` and `'rowEditStop'`. You can control how these events are handled to customize editing behavior. @@ -156,7 +156,7 @@ The object also contains a `reason` param that specifies which type of interacti The following demo shows how to prevent the user from exiting edit mode when clicking outside of a cell. To do this, the `onCellEditStop` prop is used to check if the `reason` is `'cellFocusOut'`. -If that condition is true, it [disables](/components/data-grid/events/#disabling-the-default-behavior) the default event behavior. +If that condition is true, it [disables](/x/react-data-grid/events/#disabling-the-default-behavior) the default event behavior. In this scenario, the user can only stop editing a cell by pressing Enter, Escape or Tab. {{"demo": "DisableStopEditModeOnFocusOut.js", "bg": "inline"}} @@ -295,7 +295,7 @@ function CustomEditComponent(props: GridRenderEditCellParams) { } ``` -The following demo implements a custom edit component, based on the [`Rating`](https://mui.com/components/rating) component from `@mui/material`, for the **Rating** column. +The following demo implements a custom edit component, based on the [`Rating`](https://mui.com/material-ui/react-rating) component from `@mui/material`, for the **Rating** column. {{"demo": "CustomEditComponent.js", "bg": "inline", "defaultCodeOpen": false}} @@ -362,7 +362,7 @@ const handleChange = async (event: SelectChangeEvent) => { }; ``` -The following demo implements an edit component with auto-stop, based on a native [`Select`](https://mui.com/components/selects) component for the **Role** column. +The following demo implements an edit component with auto-stop, based on a native [`Select`](/material-ui/react-select/) component for the **Role** column. {{"demo": "AutoStopEditComponent.js", "bg": "inline", "defaultCodeOpen": false}} @@ -415,5 +415,5 @@ Instead, use the buttons available in each row or in the toolbar. ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/events/events.json b/docs/data/data-grid/events/events.json index 1e3bc909effc..e61873a789a6 100644 --- a/docs/data/data-grid/events/events.json +++ b/docs/data/data-grid/events/events.json @@ -229,13 +229,13 @@ }, { "name": "rowMouseEnter", - "description": "Fired when the mouse enters the row. Called with a GridRowParams object.", + "description": "Fired when the mouse enters the row. Called with a GridRowParams object.", "params": "GridRowParams", "event": "MuiEvent>" }, { "name": "rowMouseLeave", - "description": "Fired when the mouse leaves the row. Called with a GridRowParams object.", + "description": "Fired when the mouse leaves the row. Called with a GridRowParams object.", "params": "GridRowParams", "event": "MuiEvent>" }, diff --git a/docs/data/data-grid/events/events.md b/docs/data/data-grid/events/events.md index f83ca523743a..662bde4ecee1 100644 --- a/docs/data/data-grid/events/events.md +++ b/docs/data/data-grid/events/events.md @@ -8,7 +8,7 @@ title: Data Grid - Events ## Subscribing to events -You can subscribe to one of the [events emitted](/components/data-grid/events/#catalog-of-events) by calling `apiRef.current.subscribeEvent()` with the name of the event and a handler. The handler will be called with three arguments: +You can subscribe to one of the [events emitted](/x/react-data-grid/events/#catalog-of-events) by calling `apiRef.current.subscribeEvent()` with the name of the event and a handler. The handler will be called with three arguments: 1. an object with information related to the event 2. a `MuiEvent` containing the DOM event or the React synthetic event, when available @@ -47,7 +47,7 @@ Set it to `true` to block the default handling of an event and implement your ow /> ``` -Usually, double clicking a cell will put it into [edit mode](/components/data-grid/editing/). +Usually, double clicking a cell will put it into [edit mode](/x/react-data-grid/editing/). The following example changes this behavior by also requiring CTRL to be pressed. {{"demo": "DoubleClickWithCtrlToEdit.js", "bg": "inline"}} @@ -58,5 +58,5 @@ The following example changes this behavior by also requiring C ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/export/export.md b/docs/data/data-grid/export/export.md index 084fbe227a0d..7428f9cb7066 100644 --- a/docs/data/data-grid/export/export.md +++ b/docs/data/data-grid/export/export.md @@ -10,7 +10,7 @@ title: Data Grid - Export ### Default Toolbar -To enable the export menu, pass the `GridToolbar` component in the `Toolbar` [component slot](/components/data-grid/components/#toolbar). +To enable the export menu, pass the `GridToolbar` component in the `Toolbar` [component slot](/x/react-data-grid/components/#toolbar). {{"demo": "ExportDefaultToolbar.js", "bg": "inline"}} @@ -49,8 +49,8 @@ You can customize their respective behavior by passing an options object either Each export option has its own API page: -- [`csvOptions`](/api/data-grid/grid-csv-export-options/) -- [`printOptions`](/api/data-grid/grid-print-export-options/) +- [`csvOptions`](/x/api/data-grid/grid-csv-export-options/) +- [`printOptions`](/x/api/data-grid/grid-print-export-options/) ## Disabled format @@ -99,7 +99,7 @@ By default, the grid exports the selected rows if there are any. If not, it exports all rows (filtered and sorted rows, according to active rules), including the collapsed ones. Alternatively, you can set the `getRowsToExport` function and export any rows you want, as in the following example. -The grid exports a few [selectors](/components/data-grid/state/#access-the-state) that can help you get the rows for the most common use-cases: +The grid exports a few [selectors](/x/react-data-grid/state/#access-the-state) that can help you get the rows for the most common use-cases: | Selector | Behavior | | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -110,7 +110,7 @@ The grid exports a few [selectors](/components/data-grid/state/#access-the-state | `gridPaginatedVisibleSortedGridRowIdsSelector` | The rows after applying the sorting rules, the filtering rules, without the collapsed rows and only for the current page (**Note**: If the pagination is disabled, it will still take the value of `page` and `pageSize`). | {{"demo": "CsvGetRowsToExport.js", "bg": "inline", "defaultCodeOpen": false}} -When using [Row grouping](/components/data-grid/group-pivot/#row-grouping), it can be useful to remove the groups from the CSV export +When using [Row grouping](/x/react-data-grid/group-pivot/#row-grouping), it can be useful to remove the groups from the CSV export {{"demo": "CsvGetRowsToExportRowGrouping.js", "bg": "inline", "defaultCodeOpen": false}} @@ -119,7 +119,7 @@ When using [Row grouping](/components/data-grid/group-pivot/#row-grouping), it c ### Exported cells When the value of a field is an object or a `renderCell` is provided, the CSV export might not display the value correctly. -You can provide a [`valueFormatter`](/components/data-grid/columns/#value-formatter) with a string representation to be used. +You can provide a [`valueFormatter`](/x/react-data-grid/columns/#value-formatter) with a string representation to be used. ```jsx ``` -For more option to customize the print export, please visit the [`printOptions` api page](/api/data-grid/grid-print-export-options/). +For more option to customize the print export, please visit the [`printOptions` api page](/x/api/data-grid/grid-print-export-options/). ## Custom export format @@ -252,7 +252,7 @@ The demo below shows how to add a JSON export. ## API -- [csvOptions](/api/data-grid/grid-csv-export-options/) -- [printOptions](/api/data-grid/grid-print-export-options/) -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [csvOptions](/x/api/data-grid/grid-csv-export-options/) +- [printOptions](/x/api/data-grid/grid-print-export-options/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/filtering/filtering.md b/docs/data/data-grid/filtering/filtering.md index 74ad7b85983e..c8f4825b6886 100644 --- a/docs/data/data-grid/filtering/filtering.md +++ b/docs/data/data-grid/filtering/filtering.md @@ -34,7 +34,7 @@ The following demo lets you filter the rows according to several criteria at the ### Structure of the model -The full typing details can be found on the [GridFilterModel API page](/api/data-grid/grid-filter-model/). +The full typing details can be found on the [GridFilterModel API page](/x/api/data-grid/grid-filter-model/). The filter model is composed of a list of `items` and a `linkOperator`: @@ -135,7 +135,7 @@ In the example below, the _rating_ column can not be filtered. ## Customize the operators -The full typing details can be found on the [GridFilterOperator api page](/api/data-grid/grid-filter-operator/). +The full typing details can be found on the [GridFilterOperator api page](/x/api/data-grid/grid-filter-operator/). An operator determines if a cell value should be considered as a valid filtered value. The candidate value used by the operator is the one corresponding to the `field` attribute or the value returned by the `valueGetter` of the `GridColDef`. @@ -152,7 +152,7 @@ You can get them by importing the following functions: | `dateTime` | `getGridDateOperators(true)` | | `singleSelect` | `getGridSingleSelectOperators()` | -You can find more information about the supported column types in the [columns section](/components/data-grid/columns/#column-types). +You can find more information about the supported column types in the [columns section](/x/react-data-grid/columns/#column-types). ### Create a custom operator @@ -182,9 +182,9 @@ const operator: GridFilterOperator = { }; ``` -**Note**: The [`valueFormatter`](/components/data-grid/columns/#value-formatter) is only used for rendering purposes. +**Note**: The [`valueFormatter`](/x/react-data-grid/columns/#value-formatter) is only used for rendering purposes. -**Note**: If the column has a [`valueGetter`](/components/data-grid/columns/#value-getter), then `params.value` will be the resolved value. +**Note**: If the column has a [`valueGetter`](/x/react-data-grid/columns/#value-getter), then `params.value` will be the resolved value. In the demo below, you can see how to create a completely new operator for the Rating column. @@ -254,7 +254,7 @@ In the demo below, the `rating` column reuses the numeric operators but the rati ### Custom column types -When defining a [custom column type](/components/data-grid/columns/#custom-column-types), by default the grid will reuse the operators from the type that was extended. +When defining a [custom column type](/x/react-data-grid/columns/#custom-column-types), by default the grid will reuse the operators from the type that was extended. The filter operators can then be edited just like on a regular column. ```ts @@ -268,7 +268,7 @@ const ratingColumnType: GridColTypeDef = { ## Custom filter panel -You can customize the rendering of the filter panel as shown in [the component section](/components/data-grid/components/#overriding-components) of the documentation. +You can customize the rendering of the filter panel as shown in [the component section](/x/react-data-grid/components/#overriding-components) of the documentation. ### Customize the filter panel content @@ -279,7 +279,7 @@ The available props allow overriding: - The order of the column selector (can be `"asc"` or `"desc"`) - Any prop of the input components -Input components can be [customized](/customization/how-to-customize/) by using two approaches. +Input components can be [customized](/material-ui/customization/how-to-customize/) by using two approaches. You can pass a `sx` prop to any input container or you can use CSS selectors on nested components of the filter panel. More details are available in the demo. @@ -328,12 +328,12 @@ However, it can be implemented as in the demo below. {{"demo": "FilterSelectorsNoSnap.js", "bg": "inline", "hideToolbar": true}} -More information about the selectors and how to use them on the [dedicated page](/components/data-grid/state/#access-the-state) +More information about the selectors and how to use them on the [dedicated page](/x/react-data-grid/state/#access-the-state) ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) -- [GridFilterModel](/api/data-grid/grid-filter-model/) -- [GridFilterItem](/api/data-grid/grid-filter-item/) -- [GridFilterOperator](/api/data-grid/grid-filter-operator/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) +- [GridFilterModel](/x/api/data-grid/grid-filter-model/) +- [GridFilterItem](/x/api/data-grid/grid-filter-item/) +- [GridFilterOperator](/x/api/data-grid/grid-filter-operator/) diff --git a/docs/data/data-grid/getting-started/getting-started.md b/docs/data/data-grid/getting-started/getting-started.md index c7d427591418..a99f6e4744e9 100644 --- a/docs/data/data-grid/getting-started/getting-started.md +++ b/docs/data/data-grid/getting-started/getting-started.md @@ -43,7 +43,7 @@ npm install @mui/material @mui/styled-engine-sc styled-components yarn add @mui/material @mui/styled-engine-sc styled-components ``` -> ๐Ÿ’ก Take a look at the [Styled Engine guide](/guides/styled-engine/) for more information about how to configure `styled-components` as the style engine. +> ๐Ÿ’ก Take a look at the [Styled Engine guide](/material-ui/guides/styled-engine/) for more information about how to configure `styled-components` as the style engine. ## Quickstart @@ -115,7 +115,7 @@ export default function App() { ## TypeScript -In order to benefit from the [CSS overrides](/customization/theme-components/#global-style-overrides) and [default prop customization](/customization/theme-components/#default-props) with the theme, TypeScript users need to import the following types. +In order to benefit from the [CSS overrides](/material-ui/customization/theme-components/#global-style-overrides) and [default prop customization](/material-ui/customization/theme-components/#default-props) with the theme, TypeScript users need to import the following types. Internally, it uses module augmentation to extend the default theme structure. ```tsx @@ -157,58 +157,58 @@ The following table summarizes the features available in the community `DataGrid All the features of the community version are available in the enterprise one. The enterprise components come in two plans: Pro and Premium. -| Features | Community | Pro | Premium | -| :---------------------------------------------------------------------------------------- | :-------: | :--------------------------------: | :----------------------------------------: | -| **Column** | | | -| [Column groups](/components/data-grid/columns/#column-groups) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | -| [Column spanning](/components/data-grid/columns/#column-spanning) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | -| [Column resizing](/components/data-grid/columns/#resizing) | โŒ | โœ… | โœ… | -| [Column reorder](/components/data-grid/columns/#column-reorder) | โŒ | โœ… | โœ… | -| [Column pinning](/components/data-grid/columns/#column-pinning) | โŒ | โœ… | โœ… | -| **Row** | | | | -| [Row height](/components/data-grid/rows/#row-height) | โœ… | โœ… | โœ… | -| [Row spanning](/components/data-grid/rows/#row-spanning) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | -| [Row reordering](/components/data-grid/rows/#row-reorder) | โŒ | ๐Ÿšง | ๐Ÿšง | -| [Row pinning](/components/data-grid/rows/#row-pinning) | โŒ | ๐Ÿšง | ๐Ÿšง | -| **Selection** | | | | -| [Single row selection](/components/data-grid/selection/#single-row-selection) | โœ… | โœ… | โœ… | -| [Checkbox selection](/components/data-grid/selection/#checkbox-selection) | โœ… | โœ… | โœ… | -| [Multiple row selection](/components/data-grid/selection/#multiple-row-selection) | โŒ | โœ… | โœ… | -| [Cell range selection](/components/data-grid/selection/#range-selection) | โŒ | โŒ | ๐Ÿšง | -| **Filtering** | | | | -| [Quick filter](/components/data-grid/filtering/#quick-filter) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | -| [Column filters](/components/data-grid/filtering/#single-and-multi-filtering) | โœ… | โœ… | โœ… | -| [Multi-column filtering](/components/data-grid/filtering/#multi-filtering) | โŒ | โœ… | โœ… | -| **Sorting** | | | | -| [Column sorting](/components/data-grid/sorting/) | โœ… | โœ… | โœ… | -| [Multi-column sorting](/components/data-grid/sorting/#multi-sorting) | โŒ | โœ… | โœ… | -| **Pagination** | | | | -| [Pagination](/components/data-grid/pagination/) | โœ… | โœ… | โœ… | -| [Pagination > 100 rows per page](/components/data-grid/pagination/#size-of-the-page) | โŒ | โœ… | โœ… | -| **Editing** | | | | -| [Row editing](/components/data-grid/editing/#row-editing) | โœ… | โœ… | โœ… | -| [Cell editing](/components/data-grid/editing/#cell-editing) | โœ… | โœ… | โœ… | -| **Import & export** | | | | -| [CSV export](/components/data-grid/export/#csv-export) | โœ… | โœ… | โœ… | -| [Print](/components/data-grid/export/#print-export) | โœ… | โœ… | โœ… | -| [Clipboard](/components/data-grid/export/#clipboard) | โŒ | ๐Ÿšง | ๐Ÿšง | -| [Excel export](/components/data-grid/export/#excel-export) | โŒ | โŒ | ๐Ÿšง | -| **Rendering** | | | | -| [Customizable components](/components/data-grid/components/) | โœ… | โœ… | โœ… | -| [Column virtualization](/components/data-grid/virtualization/#column-virtualization) | โœ… | โœ… | โœ… | -| [Row virtualization > 100 rows](/components/data-grid/virtualization/#row-virtualization) | โŒ | โœ… | โœ… | -| **Group & Pivot** | | | | -| [Tree data](/components/data-grid/group-pivot/#tree-data) | โŒ | โœ… | โœ… | -| [Master detail](/components/data-grid/group-pivot/#master-detail) | โŒ | โœ… | โœ… | -| [Grouping](/components/data-grid/group-pivot/#row-grouping) | โŒ | โŒ | ๐Ÿšง | -| [Aggregation](/components/data-grid/group-pivot/#aggregation) | โŒ | โŒ | ๐Ÿšง | -| [Pivoting](/components/data-grid/group-pivot/#pivoting) | โŒ | โŒ | ๐Ÿšง | -| **Misc** | | | | -| [Accessibility](/components/data-grid/accessibility/) | โœ… | โœ… | โœ… | -| [Keyboard navigation](/components/data-grid/accessibility/#keyboard-navigation) | โœ… | โœ… | โœ… | -| [Localization](/components/data-grid/localization/) | โœ… | โœ… | โœ… | +| Features | Community | Pro | Premium | +| :------------------------------------------------------------------------------------- | :-------: | :--------------------------------: | :----------------------------------------: | +| **Column** | | | +| [Column groups](/x/react-data-grid/columns/#column-groups) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | +| [Column spanning](/x/react-data-grid/columns/#column-spanning) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | +| [Column resizing](/x/react-data-grid/columns/#resizing) | โŒ | โœ… | โœ… | +| [Column reorder](/x/react-data-grid/columns/#column-reorder) | โŒ | โœ… | โœ… | +| [Column pinning](/x/react-data-grid/columns/#column-pinning) | โŒ | โœ… | โœ… | +| **Row** | | | | +| [Row height](/x/react-data-grid/rows/#row-height) | โœ… | โœ… | โœ… | +| [Row spanning](/x/react-data-grid/rows/#row-spanning) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | +| [Row reordering](/x/react-data-grid/rows/#row-reorder) | โŒ | ๐Ÿšง | ๐Ÿšง | +| [Row pinning](/x/react-data-grid/rows/#row-pinning) | โŒ | ๐Ÿšง | ๐Ÿšง | +| **Selection** | | | | +| [Single row selection](/x/react-data-grid/selection/#single-row-selection) | โœ… | โœ… | โœ… | +| [Checkbox selection](/x/react-data-grid/selection/#checkbox-selection) | โœ… | โœ… | โœ… | +| [Multiple row selection](/x/react-data-grid/selection/#multiple-row-selection) | โŒ | โœ… | โœ… | +| [Cell range selection](/x/react-data-grid/selection/#range-selection) | โŒ | โŒ | ๐Ÿšง | +| **Filtering** | | | | +| [Quick filter](/x/react-data-grid/filtering/#quick-filter) | ๐Ÿšง | ๐Ÿšง | ๐Ÿšง | +| [Column filters](/x/react-data-grid/filtering/#single-and-multi-filtering) | โœ… | โœ… | โœ… | +| [Multi-column filtering](/x/react-data-grid/filtering/#multi-filtering) | โŒ | โœ… | โœ… | +| **Sorting** | | | | +| [Column sorting](/x/react-data-grid/sorting/) | โœ… | โœ… | โœ… | +| [Multi-column sorting](/x/react-data-grid/sorting/#multi-sorting) | โŒ | โœ… | โœ… | +| **Pagination** | | | | +| [Pagination](/x/react-data-grid/pagination/) | โœ… | โœ… | โœ… | +| [Pagination > 100 rows per page](/x/react-data-grid/pagination/#size-of-the-page) | โŒ | โœ… | โœ… | +| **Editing** | | | | +| [Row editing](/x/react-data-grid/editing/#row-editing) | โœ… | โœ… | โœ… | +| [Cell editing](/x/react-data-grid/editing/#cell-editing) | โœ… | โœ… | โœ… | +| **Import & export** | | | | +| [CSV export](/x/react-data-grid/export/#csv-export) | โœ… | โœ… | โœ… | +| [Print](/x/react-data-grid/export/#print-export) | โœ… | โœ… | โœ… | +| [Clipboard](/x/react-data-grid/export/#clipboard) | โŒ | ๐Ÿšง | ๐Ÿšง | +| [Excel export](/x/react-data-grid/export/#excel-export) | โŒ | โŒ | ๐Ÿšง | +| **Rendering** | | | | +| [Customizable components](/x/react-data-grid/components/) | โœ… | โœ… | โœ… | +| [Column virtualization](/x/react-data-grid/virtualization/#column-virtualization) | โœ… | โœ… | โœ… | +| [Row virtualization > 100 rows](/x/react-data-grid/virtualization/#row-virtualization) | โŒ | โœ… | โœ… | +| **Group & Pivot** | | | | +| [Tree data](/x/react-data-grid/group-pivot/#tree-data) | โŒ | โœ… | โœ… | +| [Master detail](/x/react-data-grid/group-pivot/#master-detail) | โŒ | โœ… | โœ… | +| [Grouping](/x/react-data-grid/group-pivot/#row-grouping) | โŒ | โŒ | ๐Ÿšง | +| [Aggregation](/x/react-data-grid/group-pivot/#aggregation) | โŒ | โŒ | ๐Ÿšง | +| [Pivoting](/x/react-data-grid/group-pivot/#pivoting) | โŒ | โŒ | ๐Ÿšง | +| **Misc** | | | | +| [Accessibility](/x/react-data-grid/accessibility/) | โœ… | โœ… | โœ… | +| [Keyboard navigation](/x/react-data-grid/accessibility/#keyboard-navigation) | โœ… | โœ… | โœ… | +| [Localization](/x/react-data-grid/localization/) | โœ… | โœ… | โœ… | ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/getting-started/migration-v4.md b/docs/data/data-grid/getting-started/migration-v4.md index 2dbb7f2c6717..d43c38278f68 100644 --- a/docs/data/data-grid/getting-started/migration-v4.md +++ b/docs/data/data-grid/getting-started/migration-v4.md @@ -14,7 +14,7 @@ Most breaking changes are renaming of CSS classes or variables to improve the co ## Migrating MUI Core from v4 -> We strongly recommend you [migrate MUI Core to v5](/guides/migration-v4/) when using MUI X v5. +> We strongly recommend you [migrate MUI Core to v5](/material-ui/guides/migration-v4/) when using MUI X v5. > However, this might not be possible, depending on the complexity of the application. > The alternative is to install MUI Core v5 and configure it to keep MUI Core v4 running alongside. @@ -22,8 +22,8 @@ Most breaking changes are renaming of CSS classes or variables to improve the co Using MUI Core v4 with v5 can be achieved with the following steps: -1. First, make sure you have MUI Core v5 installed. If not, install it with these [instructions](/getting-started/installation/). -1. Add a custom [`createGenerateClassName`](/styles/api/#heading-creategenerateclassname-options-class-name-generator) to disable the generation of global class names in JSS. +1. First, make sure you have MUI Core v5 installed. If not, install it with these [instructions](/material-ui/getting-started/installation/). +1. Add a custom [`createGenerateClassName`](/system/styles/api/#heading-creategenerateclassname-options-class-name-generator) to disable the generation of global class names in JSS. ```jsx import { createGenerateClassName } from '@material-ui/core/styles'; @@ -179,7 +179,7 @@ To use the v5 version of MUI X, you first need to update to the new package name - `onRowLeave` If you depend on them, you can use `componentsProps.row` and `componentsProps.cell` to pass custom props to the row or cell. - For more information, check [this page](/components/data-grid/components/#row). Example: + For more information, check [this page](/x/react-data-grid/components/#row). Example: ```diff -; diff --git a/docs/data/data-grid/group-pivot/group-pivot.md b/docs/data/data-grid/group-pivot/group-pivot.md index b6bdea014e8c..b267f0235aec 100644 --- a/docs/data/data-grid/group-pivot/group-pivot.md +++ b/docs/data/data-grid/group-pivot/group-pivot.md @@ -332,7 +332,7 @@ Any valid React element can be used as the row detail, even another grid. The height of the detail panel content needs to be provided upfront. The grid assumes the value of 500px by default however this can be configured by passing a function to the `getDetailPanelHeight` prop that returns the required height. -Both props are called with a [`GridRowParams`](/api/data-grid/grid-row-params/) object, allowing you to return a different value for each row. +Both props are called with a [`GridRowParams`](/x/api/data-grid/grid-row-params/) object, allowing you to return a different value for each row. ```tsx Visit the [installation guide](/components/data-grid/getting-started/#installation) to learn how to install the correct package version and dependencies. +> Visit the [installation guide](/x/react-data-grid/getting-started/#installation) to learn how to install the correct package version and dependencies. Data tables display information in a grid-like format of rows and columns. They organize information in a way thatโ€™s easy to scan so that users can look for patterns and insights. @@ -24,7 +24,7 @@ The data grid comes in two different versions: ### MIT version -The first version is meant to simplify the [Table demo](/components/tables/#sorting-amp-selecting) with a clean abstraction. +The first version is meant to simplify the [Table demo](/material-ui/react-table/#sorting-amp-selecting) with a clean abstraction. This abstraction also set constraints that allow the component to implement new features. ```js @@ -51,33 +51,33 @@ import { DataGridPro } from '@mui/x-data-grid-pro'; - Built with and exclusively for React โš›๏ธ - High performance ๐Ÿš€ -- [Filtering](/components/data-grid/filtering/) and [multi-filtering](/components/data-grid/filtering/#multi-filtering) -- [Pagination](/components/data-grid/pagination/) -- [Row & Cell editing](/components/data-grid/editing/) -- [Sorting](/components/data-grid/sorting/) and [multi-sorting](/components/data-grid/sorting/#multi-sorting) -- [Selection](/components/data-grid/selection/) -- [Column virtualization](/components/data-grid/virtualization/#column-virtualization) and [rows virtualization](/components/data-grid/virtualization/#row-virtualization) -- [Row grouping](/components/data-grid/group-pivot/#row-grouping) -- [Tree data](/components/data-grid/group-pivot/#tree-data) -- [Master detail](/components/data-grid/group-pivot/#master-detail) -- [Resizable columns](/components/data-grid/columns/#resizing) -- [100% customizable](/components/data-grid/style/) +- [Filtering](/x/react-data-grid/filtering/) and [multi-filtering](/x/react-data-grid/filtering/#multi-filtering) +- [Pagination](/x/react-data-grid/pagination/) +- [Row & Cell editing](/x/react-data-grid/editing/) +- [Sorting](/x/react-data-grid/sorting/) and [multi-sorting](/x/react-data-grid/sorting/#multi-sorting) +- [Selection](/x/react-data-grid/selection/) +- [Column virtualization](/x/react-data-grid/virtualization/#column-virtualization) and [rows virtualization](/x/react-data-grid/virtualization/#row-virtualization) +- [Row grouping](/x/react-data-grid/group-pivot/#row-grouping) +- [Tree data](/x/react-data-grid/group-pivot/#tree-data) +- [Master detail](/x/react-data-grid/group-pivot/#master-detail) +- [Resizable columns](/x/react-data-grid/columns/#resizing) +- [100% customizable](/x/react-data-grid/style/) - Server-side data -- [Column hiding](/components/data-grid/columns/#column-visibility) -- [Column pinning](/components/data-grid/columns/#column-pinning) -- [Accessible](/components/data-grid/accessibility/) -- [Localization](/components/data-grid/localization/) +- [Column hiding](/x/react-data-grid/columns/#column-visibility) +- [Column pinning](/x/react-data-grid/columns/#column-pinning) +- [Accessible](/x/react-data-grid/accessibility/) +- [Localization](/x/react-data-grid/localization/) ### ๐Ÿšง Upcoming features While development of the data grid component is moving fast, there are still many additional features that we plan to implement. Some of them: - Headless (hooks only) -- [Excel export](/components/data-grid/export/) -- [Range selection](/components/data-grid/selection/#range-selection) -- [Pivot, Aggregation](/components/data-grid/group-pivot/) +- [Excel export](/x/react-data-grid/export/) +- [Range selection](/x/react-data-grid/selection/#range-selection) +- [Pivot, Aggregation](/x/react-data-grid/group-pivot/) -You can find more details on, the [feature comparison](/components/data-grid/getting-started/#feature-comparison), our living quarterly [roadmap](https://github.com/mui/mui-x/projects/1) as well as on the open [GitHub issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+label%3A%22component%3A+DataGrid%22+label%3Aenhancement). +You can find more details on, the [feature comparison](/x/react-data-grid/getting-started/#feature-comparison), our living quarterly [roadmap](https://github.com/mui/mui-x/projects/1) as well as on the open [GitHub issues](https://github.com/mui/mui-x/issues?q=is%3Aopen+label%3A%22component%3A+DataGrid%22+label%3Aenhancement). ## Resources @@ -91,5 +91,5 @@ Here are some resources you might be interested in to learn more about the grid: ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/pagination/pagination.md b/docs/data/data-grid/pagination/pagination.md index 9cf58c9226ad..a1ef8ca4a5aa 100644 --- a/docs/data/data-grid/pagination/pagination.md +++ b/docs/data/data-grid/pagination/pagination.md @@ -87,7 +87,7 @@ By default, the pagination is handled on the client. This means you have to give the rows of all pages to the grid. If your dataset is too big, and you only want to fetch the current page, you can use server-side pagination. -**Note**: For more information regarding server-side pagination in combination with controlled selection check [here](/components/data-grid/selection/#usage-with-server-side-pagination) +**Note**: For more information regarding server-side pagination in combination with controlled selection check [here](/x/react-data-grid/selection/#usage-with-server-side-pagination) ### Basic implementation @@ -120,7 +120,7 @@ To do so, you just have to keep track of the next cursor associated with each pa ## Custom pagination UI -You can customize the rendering of the pagination in the footer following [the component section](/components/data-grid/components/#pagination) of the documentation. +You can customize the rendering of the pagination in the footer following [the component section](/x/react-data-grid/components/#pagination) of the documentation. ## apiRef [](https://mui.com/store/items/material-ui-pro/) @@ -132,9 +132,9 @@ You can customize the rendering of the pagination in the footer following [the c {{"demo": "PaginationSelectorsNoSnap.js", "bg": "inline", "hideToolbar": true}} -More information about the selectors and how to use them on the [dedicated page](/components/data-grid/state/#access-the-state) +More information about the selectors and how to use them on the [dedicated page](/x/react-data-grid/state/#access-the-state) ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/rows/rows.md b/docs/data/data-grid/rows/rows.md index 82e0c0ab9e73..63bd3e976cfd 100644 --- a/docs/data/data-grid/rows/rows.md +++ b/docs/data/data-grid/rows/rows.md @@ -16,7 +16,7 @@ The rows can be defined with the `rows` prop, which expects an array of objects. {{"demo": "RowsGrid.js", "bg": "inline"}} > โš ๏ธ Each row object should have a field that uniquely identifies the row. -> By default, the grid will use the `id` property of the row. Note that [column definition](/components/data-grid/columns/#column-definitions) for `id` field is not required. +> By default, the grid will use the `id` property of the row. Note that [column definition](/x/react-data-grid/columns/#column-definitions) for `id` field is not required. > > When using dataset without a unique `id` property, you can use the `getRowId` prop to specify a custom id for each row. > @@ -76,7 +76,7 @@ The following demo updates the rows every 10ms, but they are only applied every By default, the rows have a height of 52 pixels. This matches the normal height in the [Material Design guidelines](https://material.io/components/data-tables). -If you want to create a more / less compact grid and not only set the row height, take a look at our [Density documentation](/components/data-grid/accessibility/#density-selector) +If you want to create a more / less compact grid and not only set the row height, take a look at our [Density documentation](/x/react-data-grid/accessibility/#density-selector) To change the row height for the whole grid, set the `rowHeight` prop: @@ -103,7 +103,7 @@ If you need some rows to have different row heights this can be achieved using t ## Row spacing You can use the `getRowSpacing` prop to increase the spacing between rows. -This prop is called with a [`GridRowSpacingParams`](/api/data-grid/grid-row-spacing-params/) object. +This prop is called with a [`GridRowSpacingParams`](/x/api/data-grid/grid-row-spacing-params/) object. ```tsx const getRowSpacing = React.useCallback((params: GridRowSpacingParams) => { @@ -127,13 +127,13 @@ To add a border instead, set `rowSpacingType` to `"border"` and customize the co /> ``` -> โš  Adding a bottom margin or border to rows that also have a [detail panel](/components/data-grid/group-pivot/#master-detail) is not recommended because the detail panel relays on the bottom margin to work. +> โš  Adding a bottom margin or border to rows that also have a [detail panel](/x/react-data-grid/group-pivot/#master-detail) is not recommended because the detail panel relays on the bottom margin to work. > As an alternative, only use the top spacing to define the space between rows. > It will be easier to always increase the next row spacing not matter if the detail panel is expanded or not, but you can use `gridDetailPanelExpandedRowIdsSelector` to only do when open. ## Styling rows -You can check the [styling rows](/components/data-grid/style/#styling-rows) section for more information. +You can check the [styling rows](/x/react-data-grid/style/#styling-rows) section for more information. ## ๐Ÿšง Row spanning @@ -164,5 +164,5 @@ Pinned (or frozen, locked, or sticky) rows are rows that are visible at all time ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/scrolling/scrolling.md b/docs/data/data-grid/scrolling/scrolling.md index cb434e585a8b..ace5094ebc13 100644 --- a/docs/data/data-grid/scrolling/scrolling.md +++ b/docs/data/data-grid/scrolling/scrolling.md @@ -24,5 +24,5 @@ The following demo explores the usage of this API: ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/selection/selection.md b/docs/data/data-grid/selection/selection.md index 9103826e127b..7fbec8dea26c 100644 --- a/docs/data/data-grid/selection/selection.md +++ b/docs/data/data-grid/selection/selection.md @@ -22,7 +22,7 @@ title: Data Grid - Selection - https://demos.telerik.com/kendo-ui/grid/checkbox-selection --> -Row selection can be performed with a simple mouse click, or using the [keyboard shortcuts](/components/data-grid/accessibility/#selection). The grid supports single and multiple row selection. +Row selection can be performed with a simple mouse click, or using the [keyboard shortcuts](/x/react-data-grid/accessibility/#selection). The grid supports single and multiple row selection. ### Single row selection @@ -102,5 +102,5 @@ With this feature, you will be able to select ranges of cells across the Grid. ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/sorting/sorting.md b/docs/data/data-grid/sorting/sorting.md index ea2a840c37c2..592c6310dcae 100644 --- a/docs/data/data-grid/sorting/sorting.md +++ b/docs/data/data-grid/sorting/sorting.md @@ -146,9 +146,9 @@ Sorting can be run server-side by setting the `sortingMode` prop to `server`, an {{"demo": "SortingSelectorsNoSnap.js", "bg": "inline", "hideToolbar": true}} -More information about the selectors and how to use them on the [dedicated page](/components/data-grid/state/#access-the-state) +More information about the selectors and how to use them on the [dedicated page](/x/react-data-grid/state/#access-the-state) ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/state/state.md b/docs/data/data-grid/state/state.md index 858711fcf552..32905d21deef 100644 --- a/docs/data/data-grid/state/state.md +++ b/docs/data/data-grid/state/state.md @@ -72,7 +72,7 @@ It can then be restored by either passing the returned value to the `initialStat Watch out for controlled models and their callbacks (`onFilterModelChange` if you use `filterModel`, for instance), as the grid will call those callbacks when restoring the state. But if the callback is not defined or if calling it does not update the prop value, then the restored value will not be applied. -> โš ๏ธ To avoid breaking changes, the grid only saves the column visibility if you are using the [new api](/components/data-grid/columns/#initialize-the-visible-columns) +> โš ๏ธ To avoid breaking changes, the grid only saves the column visibility if you are using the [new api](/x/react-data-grid/columns/#initialize-the-visible-columns) > Make sure to initialize `props.initialState.columns.columnVisibilityModel` or to control `props.columnVisibilityModel`. > > The easier way is to initialize the model with an empty object: @@ -119,5 +119,5 @@ apiRef.current.restoreState({ ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/style/style.md b/docs/data/data-grid/style/style.md index 907e95c7f972..7959ebaf04df 100644 --- a/docs/data/data-grid/style/style.md +++ b/docs/data/data-grid/style/style.md @@ -133,5 +133,5 @@ The following demo illustrates how this can be achieved. ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/data-grid/virtualization/virtualization.md b/docs/data/data-grid/virtualization/virtualization.md index 6f22fd34e284..d728dbaf0045 100644 --- a/docs/data/data-grid/virtualization/virtualization.md +++ b/docs/data/data-grid/virtualization/virtualization.md @@ -46,5 +46,5 @@ You may want to turn it off to be able to test the grid with a headless browser, ## API -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) +- [DataGrid](/x/api/data-grid/data-grid/) +- [DataGridPro](/x/api/data-grid/data-grid-pro/) diff --git a/docs/data/date-pickers/date-picker/date-picker-pt.md b/docs/data/date-pickers/date-picker/date-picker-pt.md index 00fa29e4907e..e77873d4126c 100644 --- a/docs/data/date-pickers/date-picker/date-picker-pt.md +++ b/docs/data/date-pickers/date-picker/date-picker-pt.md @@ -70,7 +70,7 @@ For ease of use, the date picker will automatically change the layout between po ## Subcomponentes -Some lower-level sub-components (`CalendarPicker`, `MonthPicker`, and `YearPicker`) are also exported. Estes sรฃo renderizados sem estar encapsulado ou lรณgica exterior (campo com mascara, valores de data e validaรงรฃo, etc.). +Some lower-level sub-components (`CalendarPicker`, `MonthPicker`, and `YearPicker`) are also exported. Estes sรฃo renderizados sem estar encapsulado ou lรณgica exterior (campo com mascara, valores de data e validaรงรฃo, etc.). {{"demo": "SubComponentsPickers.js"}} @@ -82,7 +82,7 @@ You can customize the rendering of the input with the `renderInput` prop. Certif ## Renderizaรงรฃo customizada do dia -Os dias exibidos sรฃo customizados com uma funรงรฃo na propriedade `renderDay`. You can take advantage of the [PickersDay](/api/pickers-day/) component. +Os dias exibidos sรฃo customizados com uma funรงรฃo na propriedade `renderDay`. You can take advantage of the [PickersDay](/x/api/date-pickers/pickers-day/) component. {{"demo": "CustomDay.js"}} diff --git a/docs/data/date-pickers/date-picker/date-picker-zh.md b/docs/data/date-pickers/date-picker/date-picker-zh.md index ddd7aaa77b06..a4b8de056223 100644 --- a/docs/data/date-pickers/date-picker/date-picker-zh.md +++ b/docs/data/date-pickers/date-picker/date-picker-zh.md @@ -82,7 +82,7 @@ You can customize the rendering of the input with the `renderInput` prop. ่ฏท็กฎ ## ่‡ชๅฎšไน‰ๆ—ฅๆœŸๆธฒๆŸ“ -ไฝ ๅฏไปฅ้€š่ฟ‡ `renderDay` ๅ‡ฝๆ•ฐๅฑžๆ€งๆฅ่‡ชๅฎšไน‰ๆ‰€ๆ˜พ็คบ็š„ๆ—ฅๆœŸใ€‚ You can take advantage of the [PickersDay](/api/pickers-day/) component. +ไฝ ๅฏไปฅ้€š่ฟ‡ `renderDay` ๅ‡ฝๆ•ฐๅฑžๆ€งๆฅ่‡ชๅฎšไน‰ๆ‰€ๆ˜พ็คบ็š„ๆ—ฅๆœŸใ€‚ You can take advantage of the [PickersDay](/x/api/date-pickers/pickers-day/) component. {{"demo": "CustomDay.js"}} diff --git a/docs/data/date-pickers/date-picker/date-picker.md b/docs/data/date-pickers/date-picker/date-picker.md index cb8246b39c15..fa41c4bb15f6 100644 --- a/docs/data/date-pickers/date-picker/date-picker.md +++ b/docs/data/date-pickers/date-picker/date-picker.md @@ -1,4 +1,5 @@ --- +product: date-pickers title: React Date Picker component components: CalendarPicker, CalendarPickerSkeleton, DatePicker, DesktopDatePicker, MobileDatePicker, MonthPicker, PickersDay, StaticDatePicker, YearPicker githubLabel: 'component: DatePicker' @@ -84,7 +85,7 @@ You can customize the rendering of the input with the `renderInput` prop. Make s ## Customized day rendering The displayed days are customizable with the `renderDay` function prop. -You can take advantage of the [PickersDay](/api/pickers-day/) component. +You can take advantage of the [PickersDay](/x/api/date-pickers/pickers-day/) component. {{"demo": "CustomDay.js"}} diff --git a/docs/data/date-pickers/date-range-picker/date-range-picker-pt.md b/docs/data/date-pickers/date-range-picker/date-range-picker-pt.md index 17ba14161b32..3a65821d5f85 100644 --- a/docs/data/date-pickers/date-range-picker/date-range-picker-pt.md +++ b/docs/data/date-pickers/date-range-picker/date-range-picker-pt.md @@ -14,7 +14,7 @@ Os seletores de intervalo de datas permitem que o usuรกrio selecione um interval ## Utilizaรงรฃo Bรกsica -Note que vocรช pode passar quase qualquer propriedade de [DatePicker](/api/date-picker/). +Note que vocรช pode passar quase qualquer propriedade de [DatePicker](/x/react-date-pickers/date-picker/). {{"demo": "BasicDateRangePicker.js"}} @@ -61,6 +61,6 @@ Desabilitar datas se comporta da mesma forma que `DatePicker`. ## Renderizaรงรฃo customizada do dia -Os dias exibidos sรฃo customizados com uma funรงรฃo na propriedade `renderDay`. You can take advantage of the internal [DateRangePickerDay](/api/date-range-picker-day/) component. +Os dias exibidos sรฃo customizados com uma funรงรฃo na propriedade `renderDay`. You can take advantage of the internal [DateRangePickerDay](/x/api/date-pickers/date-range-picker-day/) component. {{"demo": "CustomDateRangePickerDay.js"}} diff --git a/docs/data/date-pickers/date-range-picker/date-range-picker-zh.md b/docs/data/date-pickers/date-range-picker/date-range-picker-zh.md index e4a4f082366b..cf25d6924d9c 100644 --- a/docs/data/date-pickers/date-range-picker/date-range-picker-zh.md +++ b/docs/data/date-pickers/date-range-picker/date-range-picker-zh.md @@ -14,7 +14,7 @@ materialDesign: https://material.io/components/date-pickers ## ๅŸบๆœฌ็”จๆณ• -่ฏทๆณจๆ„๏ผŒไฝ ๅฏไปฅไปŽ [DatePicker](/api/date-picker/) ไธญไผ ้€’ๅ‡ ไนŽไปปไฝ•็š„ๅฑžๆ€งใ€‚ +่ฏทๆณจๆ„๏ผŒไฝ ๅฏไปฅไปŽ [DatePicker](/x/react-date-pickers/date-picker/) ไธญไผ ้€’ๅ‡ ไนŽไปปไฝ•็š„ๅฑžๆ€งใ€‚ {{"demo": "BasicDateRangePicker.js"}} @@ -61,6 +61,6 @@ The date range picker component can be disabled or read-only. ## ่‡ชๅฎšไน‰ๆ—ฅๆœŸๆธฒๆŸ“ -ไฝ ๅฏไปฅ้€š่ฟ‡ `renderDay` ๅ‡ฝๆ•ฐๅฑžๆ€งๆฅ่‡ชๅฎšไน‰ๆ‰€ๆ˜พ็คบ็š„ๆ—ฅๆœŸใ€‚ You can take advantage of the internal [DateRangePickerDay](/api/date-range-picker-day/) component. +ไฝ ๅฏไปฅ้€š่ฟ‡ `renderDay` ๅ‡ฝๆ•ฐๅฑžๆ€งๆฅ่‡ชๅฎšไน‰ๆ‰€ๆ˜พ็คบ็š„ๆ—ฅๆœŸใ€‚ You can take advantage of the internal [DateRangePickerDay](/x/api/date-pickers/date-range-picker-day/) component. {{"demo": "CustomDateRangePickerDay.js"}} 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 fe6098471fc2..e56e834bacd3 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 @@ -1,4 +1,5 @@ --- +product: date-pickers title: React Date Range Picker component components: DateRangePicker, DateRangePickerDay, DesktopDateRangePicker, MobileDateRangePicker, StaticDateRangePicker githubLabel: 'component: DateRangePicker' @@ -14,7 +15,7 @@ The date range pickers let the user select a range of dates. ## Basic usage -Note that you can pass almost any prop from [DatePicker](/api/date-picker/). +Note that you can pass almost any prop from [DatePicker](/x/react-date-pickers/date-picker/). {{"demo": "BasicDateRangePicker.js"}} @@ -64,6 +65,6 @@ If you need to render custom inputs make sure to spread `ref` and `inputProps` c ## Customized day rendering The displayed days are customizable with the `renderDay` function prop. -You can take advantage of the internal [DateRangePickerDay](/api/date-range-picker-day/) component. +You can take advantage of the internal [DateRangePickerDay](/x/api/date-pickers/date-range-picker-day/) component. {{"demo": "CustomDateRangePickerDay.js"}} diff --git a/docs/data/date-pickers/date-time-picker/date-time-picker.md b/docs/data/date-pickers/date-time-picker/date-time-picker.md index 98de7ae13ee9..7a0a0fa9e844 100644 --- a/docs/data/date-pickers/date-time-picker/date-time-picker.md +++ b/docs/data/date-pickers/date-time-picker/date-time-picker.md @@ -1,4 +1,5 @@ --- +product: date-pickers title: React Date Time Picker component components: DateTimePicker,DesktopDateTimePicker,MobileDateTimePicker,StaticDateTimePicker githubLabel: 'component: DateTimePicker' diff --git a/docs/data/date-pickers/getting-started/getting-started-pt.md b/docs/data/date-pickers/getting-started/getting-started-pt.md index 2988d9e7f876..69d080f06157 100644 --- a/docs/data/date-pickers/getting-started/getting-started-pt.md +++ b/docs/data/date-pickers/getting-started/getting-started-pt.md @@ -46,17 +46,17 @@ Um exemplo de seletor de data & hora nativo com `type="datetime-local"`. ```js // date-fns -import { DateAdapter } from '@mui/x-date-pickers/AdapterDateFns'; +import { AdapterDateFns } from '@mui/x-date-pickers/AdapterDateFns'; // or for Day.js -import { DateAdapter } from '@mui/x-date-pickers/AdapterDayjs'; +import { AdapterDayjs } from '@mui/x-date-pickers/AdapterDayjs'; // or for Luxon -import { DateAdapter } from '@mui/x-date-pickers/AdapterLuxon'; +import { AdapterLuxon } from '@mui/x-date-pickers/AdapterLuxon'; // or for Moment.js -import { DateAdapter } from '@mui/x-date-pickers/AdapterMoment'; +import { AdapterMoment } from '@mui/x-date-pickers/AdapterMoment'; function App({ children }) { return ( - {children} + {children} ); } ``` diff --git a/docs/data/date-pickers/getting-started/getting-started-zh.md b/docs/data/date-pickers/getting-started/getting-started-zh.md index 14ba558c54df..599805fcc5aa 100644 --- a/docs/data/date-pickers/getting-started/getting-started-zh.md +++ b/docs/data/date-pickers/getting-started/getting-started-zh.md @@ -7,7 +7,7 @@ waiAria: https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepick packageName: '@mui/x-date-pickers' --- -# Date/Time pickersๆ—ฅๆœŸ/ๆ—ถ้—ด้€‰ๆ‹ฉๅ™จ +# Date/Time pickers ๆ—ฅๆœŸ/ๆ—ถ้—ด้€‰ๆ‹ฉๅ™จ

ๆ—ฅๆœŸ้€‰ๆ‹ฉๅ™จๅ’Œๆ—ถ้—ด้€‰ๆ‹ฉๅ™จๆไพ›ไบ†ไธ€ไธชไปŽไบ‹ๅ…ˆ่ฎพๅฎšๅฅฝ็š„ๆ—ฅๆœŸ้›†ๅˆไธญ้€‰ๆ‹ฉๅ•ไธชๅ€ผ็š„็ฎ€ๅ•ๆ–นๆณ•ใ€‚

@@ -46,17 +46,17 @@ npm install @date-io/moment ```js // date-fns -import { DateAdapter } from '@mui/x-date-pickers/AdapterDateFns'; +import { AdapterDateFns } from '@mui/x-date-pickers/AdapterDateFns'; // or for Day.js -import { DateAdapter } from '@mui/x-date-pickers/AdapterDayjs'; +import { AdapterDayjs } from '@mui/x-date-pickers/AdapterDayjs'; // or for Luxon -import { DateAdapter } from '@mui/x-date-pickers/AdapterLuxon'; +import { AdapterLuxon } from '@mui/x-date-pickers/AdapterLuxon'; // or for Moment.js -import { DateAdapter } from '@mui/x-date-pickers/AdapterMoment'; +import { AdapterMoment } from '@mui/x-date-pickers/AdapterMoment'; function App({ children }) { return ( - {children} + {children} ); } ``` diff --git a/docs/data/date-pickers/getting-started/getting-started.md b/docs/data/date-pickers/getting-started/getting-started.md index 7f2100656774..f65171500b05 100644 --- a/docs/data/date-pickers/getting-started/getting-started.md +++ b/docs/data/date-pickers/getting-started/getting-started.md @@ -1,6 +1,7 @@ --- +product: date-pickers title: Date picker, Time picker React components -components: DatePicker,DateTimePicker,TimePicker,TextField +components: DatePicker,DateTimePicker,TimePicker githubLabel: 'component: DatePicker' materialDesign: https://material.io/components/date-pickers waiAria: https://www.w3.org/TR/wai-aria-practices/examples/dialog-modal/datepicker-dialog.html @@ -46,17 +47,19 @@ Then you have to set the `dateAdapter` prop of the `LocalizationProvider` accord ```js // date-fns -import { DateAdapter } from '@mui/x-date-pickers/AdapterDateFns'; +import { AdapterDateFns } from '@mui/x-date-pickers/AdapterDateFns'; // or for Day.js -import { DateAdapter } from '@mui/x-date-pickers/AdapterDayjs'; +import { AdapterDayjs } from '@mui/x-date-pickers/AdapterDayjs'; // or for Luxon -import { DateAdapter } from '@mui/x-date-pickers/AdapterLuxon'; +import { AdapterLuxon } from '@mui/x-date-pickers/AdapterLuxon'; // or for Moment.js -import { DateAdapter } from '@mui/x-date-pickers/AdapterMoment'; +import { AdapterMoment } from '@mui/x-date-pickers/AdapterMoment'; function App({ children }) { return ( - {children} + + {children} + ); } ``` diff --git a/docs/data/date-pickers/migration-lab/migration-lab.md b/docs/data/date-pickers/migration-lab/migration-lab.md index 1404a4bb3686..7e1fe1441cd7 100644 --- a/docs/data/date-pickers/migration-lab/migration-lab.md +++ b/docs/data/date-pickers/migration-lab/migration-lab.md @@ -11,7 +11,7 @@ title: MUI X - Migration from the lab This is a reference for migrating your site's pickers from `@mui/lab` to `@mui/x-date-pickers` or `@mui/x-date-pickers-pro`. This migration only concerns packages and should do not affect the behavior of the components in your app. -We explored the reasons of this migration in a [blog post](https://mui.com/blog/lab-date-pickers-to-mui-x/) +We explored the reasons of this migration in a [blog post](/blog/lab-date-pickers-to-mui-x/) ## License @@ -20,7 +20,7 @@ Most of our components remains MIT and are accessible for free in `@mui/x-date-p The range-picker components: `DateRangePicker`, `DateRangePickerDay`, `DesktopDateRangePicker`, `MobileDateRangePicker` and `StaticDateRangePicker` were marked as "intended for MUI X Pro" in our documentation and are now part of MUI X Pro. -If you are using one of these components, you will have to take a Pro license in order to migrate to `@mui/x-date-pickers-pro` (see the [Pricing](https://mui.com/pricing/) page for more information). +If you are using one of these components, you will have to take a Pro license in order to migrate to `@mui/x-date-pickers-pro` (see the [Pricing](/pricing/) page for more information). **Note**: If you already have a license for `@mui/x-data-grid-pro`, you can use the same one for `@mui/x-date-pickers-pro` with no additional fee! @@ -28,8 +28,6 @@ If you are using one of these components, you will have to take a Pro license in ### 1. Install MUI X packages -**Note:** `@mui/x-date-pickers-pro` re-exports everything from `@mui/x-date-pickers`. You don't have to install both when using the Pro Plan. - #### Community Plan ```sh @@ -84,3 +82,6 @@ Which will transform the imports like this: +import { DatePicker } from '@mui/x-date-pickers'; // DatePicker is also available in `@mui/x-date-pickers-pro` +import { DateRangePicker } from '@mui/x-date-pickers-pro'; ``` + +Components of the Community Plan such as `` can be imported from both `@mui/x-date-pickers-pro` and `@mui/x-date-pickers`. +Only [date adapters](/x/react-date-pickers/getting-started/#setup) such as `AdapterDayjs` can only be imported from `@mui/x-date-pickers/[adapterName]`. diff --git a/docs/data/date-pickers/time-picker/time-picker-pt.md b/docs/data/date-pickers/time-picker/time-picker-pt.md index a4a6046f48cd..267e565f09c3 100644 --- a/docs/data/date-pickers/time-picker/time-picker-pt.md +++ b/docs/data/date-pickers/time-picker/time-picker-pt.md @@ -57,7 +57,7 @@ Use `LocalizationProvider` para alterar a date-engine de localizaรงรฃo que รฉ us ## Subcomponentes -Some lower-level sub-components (`ClockPicker`) are also exported. Estes sรฃo renderizados sem estar encapsulado ou lรณgica exterior (campo com mascara, valores de data e validaรงรฃo, etc.). +Some lower-level sub-components (`ClockPicker`) are also exported. Estes sรฃo renderizados sem estar encapsulado ou lรณgica exterior (campo com mascara, valores de data e validaรงรฃo, etc.). {{"demo": "SubComponentsTimePickers.js"}} diff --git a/docs/data/date-pickers/time-picker/time-picker.md b/docs/data/date-pickers/time-picker/time-picker.md index c043f1a63964..d96336d5efa3 100644 --- a/docs/data/date-pickers/time-picker/time-picker.md +++ b/docs/data/date-pickers/time-picker/time-picker.md @@ -1,4 +1,5 @@ --- +product: date-pickers title: React Time Picker component components: DesktopTimePicker, MobileTimePicker, StaticTimePicker, TimePicker, ClockPicker githubLabel: 'component: TimePicker' diff --git a/docs/data/pages.ts b/docs/data/pages.ts index 819e2f599d30..550dee6bfa74 100644 --- a/docs/data/pages.ts +++ b/docs/data/pages.ts @@ -34,7 +34,7 @@ const pages = [ { pathname: '/x/react-data-grid/group-pivot', title: 'Group & Pivot' }, { pathname: '/x/api/data-grid', - title: 'API Reference', + title: ' โ€ข API Reference', children: [ { pathname: '/x/api/data-grid', title: 'Index' }, { pathname: '/x/api/data-grid/data-grid', title: 'DataGrid' }, @@ -64,7 +64,7 @@ const pages = [ pathname: '/x/react-date-pickers', scopePathnames: ['/x/api/date-pickers'], title: 'Date and Time Pickers', - icon: 'TableViewIcon', + icon: 'DatePickerIcon', children: [ { pathname: '/x/react-date-pickers/getting-started' }, { pathname: '/x/react-date-pickers/migration-lab', title: 'Migration from the lab' }, @@ -75,8 +75,8 @@ const pages = [ { pathname: '/x/react-date-pickers/date-time-picker' }, { pathname: '/x/react-date-pickers/time-picker' }, { - pathname: '/x/api/data-grid', - title: 'API Reference', + pathname: '/x/api/date-pickers', + title: ' โ€ข API Reference', children: [ { pathname: '/x/api/date-pickers', title: 'Index' }, { pathname: '/x/api/date-pickers/calendar-picker', title: 'CalendarPicker' }, diff --git a/docs/next.config.js b/docs/next.config.js index fe2f28c84de6..75b444c17812 100644 --- a/docs/next.config.js +++ b/docs/next.config.js @@ -2,9 +2,10 @@ const path = require('path'); const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer'); // const withTM = require('next-transpile-modules')(['@mui/monorepo']); const pkg = require('../package.json'); +const dataGridPkg = require('../packages/grid/x-data-grid/package.json'); +const datePickersPkg = require('../packages/x-date-pickers/package.json'); const { findPages } = require('./src/modules/utils/find'); const { LANGUAGES, LANGUAGES_SSR } = require('./src/modules/constants'); -const FEATURE_TOGGLE = require('./src/featureToggle'); const workspaceRoot = path.join(__dirname, '../'); @@ -38,6 +39,8 @@ module.exports = { ENABLE_AD: process.env.ENABLE_AD, GITHUB_AUTH: process.env.GITHUB_AUTH, LIB_VERSION: pkg.version, + DATA_GRID_VERSION: dataGridPkg.version, + DATE_PICKERS_VERSION: datePickersPkg.version, PULL_REQUEST: process.env.PULL_REQUEST === 'true', REACT_STRICT_MODE: reactStrictMode, // Set by Netlify @@ -152,27 +155,21 @@ module.exports = { ]; }, // redirects only take effect in the development, not production (because of `next export`). - redirects: async () => { - const redirects = []; - if (process.env.NODE_ENV !== 'production') { - redirects.push({ - source: '/', - destination: '/components/data-grid/', - permanent: false, - }); - } - if (FEATURE_TOGGLE.enable_redirects) { - redirects.push({ - source: '/components/data-grid/:path*', - destination: '/x/react-data-grid/:path*', - permanent: false, - }); - redirects.push({ - source: '/api/data-grid/:path*', - destination: '/x/api/data-grid/:path*', - permanent: false, - }); - } - return redirects; - }, + redirects: async () => [ + { + source: '/', + destination: '/x/react-data-grid/', + permanent: false, + }, + { + source: '/components/data-grid/:path*', + destination: '/x/react-data-grid/:path*', + permanent: false, + }, + { + source: '/api/data-grid/:path*', + destination: '/x/api/data-grid/:path*', + permanent: false, + }, + ], }; diff --git a/docs/package.json b/docs/package.json index 2c2d142e9fa2..1f7ff1c67c5a 100644 --- a/docs/package.json +++ b/docs/package.json @@ -43,7 +43,7 @@ "babel-plugin-preval": "^5.1.0", "babel-plugin-react-remove-properties": "^0.3.0", "babel-plugin-transform-react-remove-prop-types": "^0.4.24", - "clean-css": "^5.2.4", + "clean-css": "^5.3.0", "clipboard-copy": "^4.0.1", "clsx": "^1.1.1", "core-js": "^2.6.12", @@ -67,10 +67,10 @@ "react": "^17.0.2", "react-docgen": "^5.4.0", "react-dom": "^17.0.2", - "react-hook-form": "^7.28.1", + "react-hook-form": "^7.29.0", "react-is": "^17.0.2", - "react-router": "^6.2.2", - "react-router-dom": "^6.2.2", + "react-router": "^6.3.0", + "react-router-dom": "^6.3.0", "react-text-mask": "^5.4.3", "recast": "^0.20.5", "rimraf": "^3.0.2", diff --git a/docs/pages/api-docs/data-grid/data-grid-pro.js b/docs/pages/api-docs/data-grid/data-grid-pro.js deleted file mode 100644 index fefccdfe27e1..000000000000 --- a/docs/pages/api-docs/data-grid/data-grid-pro.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './data-grid-pro.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/data-grid', - false, - /\/data-grid-pro(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/data-grid/data-grid-pro.json b/docs/pages/api-docs/data-grid/data-grid-pro.json deleted file mode 100644 index b6b201543c59..000000000000 --- a/docs/pages/api-docs/data-grid/data-grid-pro.json +++ /dev/null @@ -1,402 +0,0 @@ -{ - "props": { - "columns": { - "type": { "name": "arrayOf", "description": "Array<object>" }, - "required": true - }, - "rows": { "type": { "name": "array" }, "required": true }, - "apiRef": { "type": { "name": "shape", "description": "{ current: object }" } }, - "aria-label": { "type": { "name": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, - "autoHeight": { "type": { "name": "bool" } }, - "autoPageSize": { "type": { "name": "bool" } }, - "checkboxSelection": { "type": { "name": "bool" } }, - "checkboxSelectionVisibleOnly": { - "type": { "name": "custom", "description": "bool" }, - "default": "false" - }, - "classes": { "type": { "name": "object" } }, - "columnBuffer": { "type": { "name": "number" }, "default": "3" }, - "columnThreshold": { "type": { "name": "number" }, "default": "3" }, - "columnTypes": { "type": { "name": "object" } }, - "columnVisibilityModel": { "type": { "name": "object" } }, - "components": { "type": { "name": "object" } }, - "componentsProps": { "type": { "name": "object" } }, - "defaultGroupingExpansionDepth": { "type": { "name": "number" }, "default": "0" }, - "density": { - "type": { - "name": "enum", - "description": "'comfortable'
| 'compact'
| 'standard'" - }, - "default": "\"standard\"" - }, - "detailPanelExpandedRowIds": { - "type": { "name": "arrayOf", "description": "Array<number
| string>" } - }, - "disableChildrenFiltering": { "type": { "name": "bool" } }, - "disableChildrenSorting": { "type": { "name": "bool" } }, - "disableColumnFilter": { "type": { "name": "bool" } }, - "disableColumnMenu": { "type": { "name": "bool" } }, - "disableColumnPinning": { "type": { "name": "bool" } }, - "disableColumnReorder": { "type": { "name": "bool" } }, - "disableColumnResize": { "type": { "name": "bool" } }, - "disableColumnSelector": { "type": { "name": "bool" } }, - "disableDensitySelector": { "type": { "name": "bool" } }, - "disableExtendRowFullWidth": { "type": { "name": "bool" } }, - "disableMultipleColumnsFiltering": { "type": { "name": "bool" } }, - "disableMultipleColumnsSorting": { "type": { "name": "bool" } }, - "disableMultipleSelection": { "type": { "name": "bool" } }, - "disableRowGrouping": { "type": { "name": "bool" } }, - "disableSelectionOnClick": { "type": { "name": "bool" } }, - "disableVirtualization": { "type": { "name": "bool" } }, - "editMode": { - "type": { "name": "enum", "description": "'cell'
| 'row'" }, - "default": "\"cell\"" - }, - "editRowsModel": { "type": { "name": "object" } }, - "error": { "type": { "name": "any" } }, - "experimentalFeatures": { - "type": { - "name": "shape", - "description": "{ newEditingApi?: bool, preventCommitWhileValidating?: bool, rowGrouping?: bool, warnIfFocusStateIsNotSynced?: bool }" - } - }, - "filterMode": { - "type": { "name": "custom", "description": "'client'
| 'server'" }, - "default": "\"client\"" - }, - "filterModel": { - "type": { - "name": "shape", - "description": "{ items: Array<{ columnField: string, id?: number
| string, operatorValue?: string, value?: any }>, linkOperator?: 'and'
| 'or' }" - } - }, - "getCellClassName": { "type": { "name": "func" } }, - "getDetailPanelContent": { "type": { "name": "func" } }, - "getDetailPanelHeight": { "type": { "name": "func" }, "default": "\"() => 500\"" }, - "getRowClassName": { "type": { "name": "func" } }, - "getRowHeight": { "type": { "name": "func" } }, - "getRowId": { "type": { "name": "func" } }, - "getRowSpacing": { "type": { "name": "func" } }, - "getTreeDataPath": { "type": { "name": "func" } }, - "groupingColDef": { "type": { "name": "union", "description": "func
| object" } }, - "headerHeight": { "type": { "name": "number" }, "default": "56" }, - "hideFooter": { "type": { "name": "bool" } }, - "hideFooterPagination": { "type": { "name": "bool" } }, - "hideFooterRowCount": { - "type": { "name": "custom", "description": "bool" }, - "default": "false" - }, - "hideFooterSelectedRowCount": { "type": { "name": "bool" } }, - "initialState": { "type": { "name": "object" } }, - "isCellEditable": { "type": { "name": "func" } }, - "isGroupExpandedByDefault": { "type": { "name": "func" } }, - "isRowSelectable": { "type": { "name": "func" } }, - "loading": { "type": { "name": "bool" } }, - "localeText": { "type": { "name": "object" } }, - "logger": { - "type": { - "name": "shape", - "description": "{ debug: func, error: func, info: func, warn: func }" - }, - "default": "console" - }, - "logLevel": { - "type": { - "name": "enum", - "description": "'debug'
| 'error'
| 'info'
| 'warn'
| false" - }, - "default": "\"debug\"" - }, - "nonce": { "type": { "name": "string" } }, - "onCellClick": { "type": { "name": "func" } }, - "onCellDoubleClick": { "type": { "name": "func" } }, - "onCellEditCommit": { "type": { "name": "func" } }, - "onCellEditStart": { "type": { "name": "func" } }, - "onCellEditStop": { "type": { "name": "func" } }, - "onCellFocusOut": { "type": { "name": "func" } }, - "onCellKeyDown": { "type": { "name": "func" } }, - "onColumnHeaderClick": { "type": { "name": "func" } }, - "onColumnHeaderDoubleClick": { "type": { "name": "func" } }, - "onColumnHeaderEnter": { "type": { "name": "func" } }, - "onColumnHeaderLeave": { "type": { "name": "func" } }, - "onColumnHeaderOut": { "type": { "name": "func" } }, - "onColumnHeaderOver": { "type": { "name": "func" } }, - "onColumnOrderChange": { "type": { "name": "func" } }, - "onColumnResize": { "type": { "name": "func" } }, - "onColumnVisibilityChange": { - "type": { "name": "func" }, - "deprecated": true, - "deprecationInfo": "Use onColumnVisibilityModelChange instead." - }, - "onColumnVisibilityModelChange": { "type": { "name": "func" } }, - "onColumnWidthChange": { "type": { "name": "func" } }, - "onDetailPanelExpandedRowIdsChange": { "type": { "name": "func" } }, - "onEditCellPropsChange": { - "type": { "name": "func" }, - "deprecated": true, - "deprecationInfo": "use preProcessEditCellProps from the GridColDef" - }, - "onEditRowsModelChange": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onFilterModelChange": { "type": { "name": "func" } }, - "onPageChange": { "type": { "name": "func" } }, - "onPageSizeChange": { "type": { "name": "func" } }, - "onPinnedColumnsChange": { "type": { "name": "func" } }, - "onPreferencePanelClose": { "type": { "name": "func" } }, - "onPreferencePanelOpen": { "type": { "name": "func" } }, - "onProcessRowUpdateError": { "type": { "name": "func" } }, - "onResize": { "type": { "name": "func" } }, - "onRowClick": { "type": { "name": "func" } }, - "onRowDoubleClick": { "type": { "name": "func" } }, - "onRowEditCommit": { "type": { "name": "func" } }, - "onRowEditStart": { "type": { "name": "func" } }, - "onRowEditStop": { "type": { "name": "func" } }, - "onRowGroupingModelChange": { "type": { "name": "func" } }, - "onRowsScrollEnd": { "type": { "name": "func" } }, - "onSelectionModelChange": { "type": { "name": "func" } }, - "onSortModelChange": { "type": { "name": "func" } }, - "onStateChange": { "type": { "name": "func" } }, - "page": { "type": { "name": "number" }, "default": "0" }, - "pageSize": { "type": { "name": "number" }, "default": "100" }, - "pagination": { "type": { "name": "bool" } }, - "paginationMode": { - "type": { "name": "enum", "description": "'client'
| 'server'" }, - "default": "\"client\"" - }, - "pinnedColumns": { - "type": { - "name": "shape", - "description": "{ left?: Array<string>, right?: Array<string> }" - } - }, - "processRowUpdate": { "type": { "name": "func" } }, - "rowBuffer": { "type": { "name": "number" }, "default": "3" }, - "rowCount": { "type": { "name": "number" } }, - "rowGroupingColumnMode": { - "type": { "name": "enum", "description": "'multiple'
| 'single'" }, - "default": "'single'" - }, - "rowGroupingModel": { "type": { "name": "arrayOf", "description": "Array<string>" } }, - "rowHeight": { "type": { "name": "number" }, "default": "52" }, - "rowSpacingType": { - "type": { "name": "enum", "description": "'border'
| 'margin'" }, - "default": "\"margin\"" - }, - "rowsPerPageOptions": { - "type": { "name": "arrayOf", "description": "Array<number>" }, - "default": "[25, 50, 100]" - }, - "rowThreshold": { "type": { "name": "number" }, "default": "3" }, - "scrollbarSize": { "type": { "name": "number" } }, - "scrollEndThreshold": { "type": { "name": "number" }, "default": "80" }, - "selectionModel": { - "type": { - "name": "union", - "description": "Array<number
| string>
| number
| string" - } - }, - "showCellRightBorder": { "type": { "name": "bool" } }, - "showColumnRightBorder": { "type": { "name": "bool" } }, - "sortingMode": { - "type": { "name": "enum", "description": "'client'
| 'server'" }, - "default": "\"client\"" - }, - "sortingOrder": { - "type": { "name": "arrayOf", "description": "Array<'asc'
| 'desc'>" }, - "default": "['asc', 'desc', null]" - }, - "sortModel": { - "type": { - "name": "arrayOf", - "description": "Array<{ field: string, sort?: 'asc'
| 'desc' }>" - } - }, - "sx": { - "type": { - "name": "union", - "description": "Array<func
| object
| bool>
| func
| object" - } - }, - "throttleRowsMs": { "type": { "name": "number" }, "default": "0" }, - "treeData": { "type": { "name": "bool" } } - }, - "slots": { - "BaseButton": { "default": "Button", "type": { "name": "elementType" } }, - "BaseCheckbox": { "default": "Checkbox", "type": { "name": "elementType" } }, - "BaseFormControl": { "default": "FormControl", "type": { "name": "elementType" } }, - "BasePopper": { "default": "Popper", "type": { "name": "elementType" } }, - "BaseSelect": { "default": "Select", "type": { "name": "elementType" } }, - "BaseSwitch": { "default": "Switch", "type": { "name": "elementType" } }, - "BaseTextField": { "default": "TextField", "type": { "name": "elementType" } }, - "BaseTooltip": { "default": "Tooltip", "type": { "name": "elementType" } }, - "BooleanCellFalseIcon": { "default": "GridCloseIcon", "type": { "name": "elementType" } }, - "BooleanCellTrueIcon": { "default": "GridCheckIcon", "type": { "name": "elementType" } }, - "Cell": { "default": "GridCell", "type": { "name": "elementType" } }, - "ColumnFilteredIcon": { "default": "GridFilterAltIcon", "type": { "name": "elementType" } }, - "ColumnHeaderFilterIconButton": { - "default": "GridColumnHeaderFilterIconButton", - "type": { "name": "elementType" } - }, - "ColumnMenu": { "default": "GridColumnMenu", "type": { "name": "elementType" } }, - "ColumnMenuIcon": { - "default": "GridTripleDotsVerticalIcon", - "type": { "name": "elementType" } - }, - "ColumnResizeIcon": { "default": "GridSeparatorIcon", "type": { "name": "elementType" } }, - "ColumnSelectorIcon": { "default": "GridColumnIcon", "type": { "name": "elementType" } }, - "ColumnSortedAscendingIcon": { - "default": "GridArrowUpwardIcon", - "type": { "name": "elementType | null" } - }, - "ColumnSortedDescendingIcon": { - "default": "GridArrowDownwardIcon", - "type": { "name": "elementType | null" } - }, - "ColumnsPanel": { "default": "GridColumnsPanel", "type": { "name": "elementType" } }, - "ColumnUnsortedIcon": { - "default": "GridColumnUnsortedIcon", - "type": { "name": "elementType | null" } - }, - "DensityComfortableIcon": { - "default": "GridViewStreamIcon", - "type": { "name": "elementType" } - }, - "DensityCompactIcon": { "default": "GridViewHeadlineIcon", "type": { "name": "elementType" } }, - "DensityStandardIcon": { "default": "GridTableRowsIcon", "type": { "name": "elementType" } }, - "DetailPanelCollapseIcon": { "default": "GridRemoveIcon", "type": { "name": "elementType" } }, - "DetailPanelExpandIcon": { "default": "GridAddIcon", "type": { "name": "elementType" } }, - "ErrorOverlay": { "default": "ErrorOverlay", "type": { "name": "elementType" } }, - "ExportIcon": { "default": "GridSaveAltIcon", "type": { "name": "elementType" } }, - "FilterPanel": { "default": "GridFilterPanel", "type": { "name": "elementType" } }, - "FilterPanelDeleteIcon": { "default": "GridCloseIcon", "type": { "name": "elementType" } }, - "Footer": { "default": "GridFooter", "type": { "name": "elementType" } }, - "GroupingCriteriaCollapseIcon": { - "default": "GridExpandMoreIcon", - "type": { "name": "elementType" } - }, - "GroupingCriteriaExpandIcon": { - "default": "GridKeyboardArrowRight", - "type": { "name": "elementType" } - }, - "Header": { "default": "GridHeader", "type": { "name": "elementType" } }, - "LoadingOverlay": { "default": "GridLoadingOverlay", "type": { "name": "elementType" } }, - "MoreActionsIcon": { "default": "GridMoreVertIcon", "type": { "name": "elementType" } }, - "NoResultsOverlay": { "default": "GridNoResultsOverlay", "type": { "name": "elementType" } }, - "NoRowsOverlay": { "default": "GridNoRowsOverlay", "type": { "name": "elementType" } }, - "OpenFilterButtonIcon": { "default": "GridFilterListIcon", "type": { "name": "elementType" } }, - "Pagination": { "default": "Pagination", "type": { "name": "elementType | null" } }, - "Panel": { "default": "GridPanel", "type": { "name": "elementType" } }, - "PreferencesPanel": { "default": "GridPreferencesPanel", "type": { "name": "elementType" } }, - "Row": { "default": "GridRow", "type": { "name": "elementType" } }, - "Toolbar": { "default": "null", "type": { "name": "elementType | null" } }, - "TreeDataCollapseIcon": { "default": "GridExpandMoreIcon", "type": { "name": "elementType" } }, - "TreeDataExpandIcon": { "default": "GridKeyboardArrowRight", "type": { "name": "elementType" } } - }, - "name": "DataGridPro", - "styles": { - "classes": [ - "actionsCell", - "autoHeight", - "booleanCell", - "cell--editable", - "cell--editing", - "cell--textCenter", - "cell--textLeft", - "cell--textRight", - "cell--withRenderer", - "cell", - "cellContent", - "cellCheckbox", - "checkboxInput", - "columnHeader--alignCenter", - "columnHeader--alignLeft", - "columnHeader--alignRight", - "columnHeader--dragging", - "columnHeader--moving", - "columnHeader--numeric", - "columnHeader--sortable", - "columnHeader--sorted", - "columnHeader--filtered", - "columnHeader", - "columnHeaderCheckbox", - "columnHeaderDraggableContainer", - "columnHeaderDropZone", - "columnHeaderTitle", - "columnHeaderTitleContainer", - "columnHeaderTitleContainerContent", - "columnHeaders", - "columnHeadersInner", - "columnHeadersInner--scrollable", - "columnSeparator--resizable", - "columnSeparator--resizing", - "columnSeparator--sideLeft", - "columnSeparator--sideRight", - "columnSeparator", - "columnsPanel", - "columnsPanelRow", - "detailPanel", - "detailPanels", - "detailPanelToggleCell", - "detailPanelToggleCell--expanded", - "panel", - "panelHeader", - "panelWrapper", - "panelContent", - "panelFooter", - "paper", - "editBooleanCell", - "filterForm", - "filterFormDeleteIcon", - "filterFormLinkOperatorInput", - "filterFormColumnInput", - "filterFormOperatorInput", - "filterFormValueInput", - "editInputCell", - "filterIcon", - "footerContainer", - "iconButtonContainer", - "iconSeparator", - "main", - "menu", - "menuIcon", - "menuIconButton", - "menuOpen", - "menuList", - "overlay", - "virtualScroller", - "virtualScrollerContent", - "virtualScrollerContent--overflowed", - "virtualScrollerRenderZone", - "pinnedColumns", - "pinnedColumns--left", - "pinnedColumns--right", - "pinnedColumnHeaders", - "pinnedColumnHeaders--left", - "pinnedColumnHeaders--right", - "root", - "row--editable", - "row--editing", - "row--lastVisible", - "row", - "rowCount", - "scrollArea", - "scrollArea--left", - "scrollArea--right", - "selectedRowCount", - "sortIcon", - "toolbarContainer", - "toolbarFilterList", - "withBorder", - "treeDataGroupingCell", - "treeDataGroupingCellToggle", - "groupingCriteriaCell", - "groupingCriteriaCellToggle" - ], - "globalClasses": {}, - "name": "MuiDataGrid" - }, - "forwardsRefTo": "GridRoot", - "filename": "/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx", - "demos": "" -} diff --git a/docs/pages/api-docs/data-grid/data-grid.js b/docs/pages/api-docs/data-grid/data-grid.js deleted file mode 100644 index 7514580f303e..000000000000 --- a/docs/pages/api-docs/data-grid/data-grid.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './data-grid.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/data-grid', - false, - /\/data-grid(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/data-grid/data-grid.json b/docs/pages/api-docs/data-grid/data-grid.json deleted file mode 100644 index de61b21ef599..000000000000 --- a/docs/pages/api-docs/data-grid/data-grid.json +++ /dev/null @@ -1,352 +0,0 @@ -{ - "props": { - "columns": { "type": { "name": "custom", "description": "array" }, "required": true }, - "rows": { "type": { "name": "array" }, "required": true }, - "aria-label": { "type": { "name": "string" } }, - "aria-labelledby": { "type": { "name": "string" } }, - "autoHeight": { "type": { "name": "bool" } }, - "autoPageSize": { "type": { "name": "bool" } }, - "checkboxSelection": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, - "columnBuffer": { "type": { "name": "number" }, "default": "3" }, - "columnThreshold": { "type": { "name": "number" }, "default": "3" }, - "columnTypes": { "type": { "name": "object" } }, - "columnVisibilityModel": { "type": { "name": "object" } }, - "components": { "type": { "name": "object" } }, - "componentsProps": { "type": { "name": "object" } }, - "density": { - "type": { - "name": "enum", - "description": "'comfortable'
| 'compact'
| 'standard'" - }, - "default": "\"standard\"" - }, - "disableColumnFilter": { "type": { "name": "bool" } }, - "disableColumnMenu": { "type": { "name": "bool" } }, - "disableColumnSelector": { "type": { "name": "bool" } }, - "disableDensitySelector": { "type": { "name": "bool" } }, - "disableExtendRowFullWidth": { "type": { "name": "bool" } }, - "disableSelectionOnClick": { "type": { "name": "bool" } }, - "disableVirtualization": { "type": { "name": "bool" } }, - "editMode": { - "type": { "name": "enum", "description": "'cell'
| 'row'" }, - "default": "\"cell\"" - }, - "editRowsModel": { "type": { "name": "object" } }, - "error": { "type": { "name": "any" } }, - "experimentalFeatures": { - "type": { - "name": "shape", - "description": "{ newEditingApi?: bool, preventCommitWhileValidating?: bool, warnIfFocusStateIsNotSynced?: bool }" - } - }, - "filterMode": { - "type": { "name": "enum", "description": "'client'
| 'server'" }, - "default": "\"client\"" - }, - "filterModel": { - "type": { - "name": "shape", - "description": "{ items: Array<{ columnField: string, id?: number
| string, operatorValue?: string, value?: any }>, linkOperator?: 'and'
| 'or' }" - } - }, - "getCellClassName": { "type": { "name": "func" } }, - "getDetailPanelContent": { "type": { "name": "func" } }, - "getRowClassName": { "type": { "name": "func" } }, - "getRowHeight": { "type": { "name": "func" } }, - "getRowId": { "type": { "name": "func" } }, - "getRowSpacing": { "type": { "name": "func" } }, - "headerHeight": { "type": { "name": "number" }, "default": "56" }, - "hideFooter": { "type": { "name": "bool" } }, - "hideFooterPagination": { "type": { "name": "bool" } }, - "hideFooterSelectedRowCount": { "type": { "name": "bool" } }, - "initialState": { "type": { "name": "object" } }, - "isCellEditable": { "type": { "name": "func" } }, - "isRowSelectable": { "type": { "name": "func" } }, - "loading": { "type": { "name": "bool" } }, - "localeText": { "type": { "name": "object" } }, - "logger": { - "type": { - "name": "shape", - "description": "{ debug: func, error: func, info: func, warn: func }" - }, - "default": "console" - }, - "logLevel": { - "type": { - "name": "enum", - "description": "'debug'
| 'error'
| 'info'
| 'warn'
| false" - }, - "default": "\"debug\"" - }, - "nonce": { "type": { "name": "string" } }, - "onCellClick": { "type": { "name": "func" } }, - "onCellDoubleClick": { "type": { "name": "func" } }, - "onCellEditCommit": { "type": { "name": "func" } }, - "onCellEditStart": { "type": { "name": "func" } }, - "onCellEditStop": { "type": { "name": "func" } }, - "onCellFocusOut": { "type": { "name": "func" } }, - "onCellKeyDown": { "type": { "name": "func" } }, - "onColumnHeaderClick": { "type": { "name": "func" } }, - "onColumnHeaderDoubleClick": { "type": { "name": "func" } }, - "onColumnHeaderEnter": { "type": { "name": "func" } }, - "onColumnHeaderLeave": { "type": { "name": "func" } }, - "onColumnHeaderOut": { "type": { "name": "func" } }, - "onColumnHeaderOver": { "type": { "name": "func" } }, - "onColumnOrderChange": { "type": { "name": "func" } }, - "onColumnVisibilityChange": { - "type": { "name": "func" }, - "deprecated": true, - "deprecationInfo": "Use onColumnVisibilityModelChange instead." - }, - "onColumnVisibilityModelChange": { "type": { "name": "func" } }, - "onEditCellPropsChange": { - "type": { "name": "func" }, - "deprecated": true, - "deprecationInfo": "use preProcessEditCellProps from the GridColDef" - }, - "onEditRowsModelChange": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onFilterModelChange": { "type": { "name": "func" } }, - "onPageChange": { "type": { "name": "func" } }, - "onPageSizeChange": { "type": { "name": "func" } }, - "onPreferencePanelClose": { "type": { "name": "func" } }, - "onPreferencePanelOpen": { "type": { "name": "func" } }, - "onProcessRowUpdateError": { "type": { "name": "func" } }, - "onResize": { "type": { "name": "func" } }, - "onRowClick": { "type": { "name": "func" } }, - "onRowDoubleClick": { "type": { "name": "func" } }, - "onRowEditCommit": { "type": { "name": "func" } }, - "onRowEditStart": { "type": { "name": "func" } }, - "onRowEditStop": { "type": { "name": "func" } }, - "onSelectionModelChange": { "type": { "name": "func" } }, - "onSortModelChange": { "type": { "name": "func" } }, - "onStateChange": { "type": { "name": "func" } }, - "page": { "type": { "name": "number" }, "default": "0" }, - "pageSize": { "type": { "name": "custom", "description": "number" }, "default": "100" }, - "paginationMode": { - "type": { "name": "enum", "description": "'client'
| 'server'" }, - "default": "\"client\"" - }, - "processRowUpdate": { "type": { "name": "func" } }, - "rowBuffer": { "type": { "name": "number" }, "default": "3" }, - "rowCount": { "type": { "name": "number" } }, - "rowHeight": { "type": { "name": "number" }, "default": "52" }, - "rowSpacingType": { - "type": { "name": "enum", "description": "'border'
| 'margin'" }, - "default": "\"margin\"" - }, - "rowsPerPageOptions": { - "type": { "name": "arrayOf", "description": "Array<number>" }, - "default": "[25, 50, 100]" - }, - "rowThreshold": { "type": { "name": "number" }, "default": "3" }, - "scrollbarSize": { "type": { "name": "number" } }, - "selectionModel": { - "type": { - "name": "custom", - "description": "number
| string
| array" - } - }, - "showCellRightBorder": { "type": { "name": "bool" } }, - "showColumnRightBorder": { "type": { "name": "bool" } }, - "sortingMode": { - "type": { "name": "enum", "description": "'client'
| 'server'" }, - "default": "\"client\"" - }, - "sortingOrder": { - "type": { "name": "arrayOf", "description": "Array<'asc'
| 'desc'>" }, - "default": "['asc', 'desc', null]" - }, - "sortModel": { - "type": { - "name": "arrayOf", - "description": "Array<{ field: string, sort?: 'asc'
| 'desc' }>" - } - }, - "sx": { - "type": { - "name": "union", - "description": "Array<func
| object
| bool>
| func
| object" - } - } - }, - "slots": { - "BaseButton": { "default": "Button", "type": { "name": "elementType" } }, - "BaseCheckbox": { "default": "Checkbox", "type": { "name": "elementType" } }, - "BaseFormControl": { "default": "FormControl", "type": { "name": "elementType" } }, - "BasePopper": { "default": "Popper", "type": { "name": "elementType" } }, - "BaseSelect": { "default": "Select", "type": { "name": "elementType" } }, - "BaseSwitch": { "default": "Switch", "type": { "name": "elementType" } }, - "BaseTextField": { "default": "TextField", "type": { "name": "elementType" } }, - "BaseTooltip": { "default": "Tooltip", "type": { "name": "elementType" } }, - "BooleanCellFalseIcon": { "default": "GridCloseIcon", "type": { "name": "elementType" } }, - "BooleanCellTrueIcon": { "default": "GridCheckIcon", "type": { "name": "elementType" } }, - "Cell": { "default": "GridCell", "type": { "name": "elementType" } }, - "ColumnFilteredIcon": { "default": "GridFilterAltIcon", "type": { "name": "elementType" } }, - "ColumnHeaderFilterIconButton": { - "default": "GridColumnHeaderFilterIconButton", - "type": { "name": "elementType" } - }, - "ColumnMenu": { "default": "GridColumnMenu", "type": { "name": "elementType" } }, - "ColumnMenuIcon": { - "default": "GridTripleDotsVerticalIcon", - "type": { "name": "elementType" } - }, - "ColumnResizeIcon": { "default": "GridSeparatorIcon", "type": { "name": "elementType" } }, - "ColumnSelectorIcon": { "default": "GridColumnIcon", "type": { "name": "elementType" } }, - "ColumnSortedAscendingIcon": { - "default": "GridArrowUpwardIcon", - "type": { "name": "elementType | null" } - }, - "ColumnSortedDescendingIcon": { - "default": "GridArrowDownwardIcon", - "type": { "name": "elementType | null" } - }, - "ColumnsPanel": { "default": "GridColumnsPanel", "type": { "name": "elementType" } }, - "ColumnUnsortedIcon": { - "default": "GridColumnUnsortedIcon", - "type": { "name": "elementType | null" } - }, - "DensityComfortableIcon": { - "default": "GridViewStreamIcon", - "type": { "name": "elementType" } - }, - "DensityCompactIcon": { "default": "GridViewHeadlineIcon", "type": { "name": "elementType" } }, - "DensityStandardIcon": { "default": "GridTableRowsIcon", "type": { "name": "elementType" } }, - "DetailPanelCollapseIcon": { "default": "GridRemoveIcon", "type": { "name": "elementType" } }, - "DetailPanelExpandIcon": { "default": "GridAddIcon", "type": { "name": "elementType" } }, - "ErrorOverlay": { "default": "ErrorOverlay", "type": { "name": "elementType" } }, - "ExportIcon": { "default": "GridSaveAltIcon", "type": { "name": "elementType" } }, - "FilterPanel": { "default": "GridFilterPanel", "type": { "name": "elementType" } }, - "FilterPanelDeleteIcon": { "default": "GridCloseIcon", "type": { "name": "elementType" } }, - "Footer": { "default": "GridFooter", "type": { "name": "elementType" } }, - "GroupingCriteriaCollapseIcon": { - "default": "GridExpandMoreIcon", - "type": { "name": "elementType" } - }, - "GroupingCriteriaExpandIcon": { - "default": "GridKeyboardArrowRight", - "type": { "name": "elementType" } - }, - "Header": { "default": "GridHeader", "type": { "name": "elementType" } }, - "LoadingOverlay": { "default": "GridLoadingOverlay", "type": { "name": "elementType" } }, - "MoreActionsIcon": { "default": "GridMoreVertIcon", "type": { "name": "elementType" } }, - "NoResultsOverlay": { "default": "GridNoResultsOverlay", "type": { "name": "elementType" } }, - "NoRowsOverlay": { "default": "GridNoRowsOverlay", "type": { "name": "elementType" } }, - "OpenFilterButtonIcon": { "default": "GridFilterListIcon", "type": { "name": "elementType" } }, - "Pagination": { "default": "Pagination", "type": { "name": "elementType | null" } }, - "Panel": { "default": "GridPanel", "type": { "name": "elementType" } }, - "PreferencesPanel": { "default": "GridPreferencesPanel", "type": { "name": "elementType" } }, - "Row": { "default": "GridRow", "type": { "name": "elementType" } }, - "Toolbar": { "default": "null", "type": { "name": "elementType | null" } }, - "TreeDataCollapseIcon": { "default": "GridExpandMoreIcon", "type": { "name": "elementType" } }, - "TreeDataExpandIcon": { "default": "GridKeyboardArrowRight", "type": { "name": "elementType" } } - }, - "name": "DataGrid", - "styles": { - "classes": [ - "actionsCell", - "autoHeight", - "booleanCell", - "cell--editable", - "cell--editing", - "cell--textCenter", - "cell--textLeft", - "cell--textRight", - "cell--withRenderer", - "cell", - "cellContent", - "cellCheckbox", - "checkboxInput", - "columnHeader--alignCenter", - "columnHeader--alignLeft", - "columnHeader--alignRight", - "columnHeader--dragging", - "columnHeader--moving", - "columnHeader--numeric", - "columnHeader--sortable", - "columnHeader--sorted", - "columnHeader--filtered", - "columnHeader", - "columnHeaderCheckbox", - "columnHeaderDraggableContainer", - "columnHeaderDropZone", - "columnHeaderTitle", - "columnHeaderTitleContainer", - "columnHeaderTitleContainerContent", - "columnHeaders", - "columnHeadersInner", - "columnHeadersInner--scrollable", - "columnSeparator--resizable", - "columnSeparator--resizing", - "columnSeparator--sideLeft", - "columnSeparator--sideRight", - "columnSeparator", - "columnsPanel", - "columnsPanelRow", - "detailPanel", - "detailPanels", - "detailPanelToggleCell", - "detailPanelToggleCell--expanded", - "panel", - "panelHeader", - "panelWrapper", - "panelContent", - "panelFooter", - "paper", - "editBooleanCell", - "filterForm", - "filterFormDeleteIcon", - "filterFormLinkOperatorInput", - "filterFormColumnInput", - "filterFormOperatorInput", - "filterFormValueInput", - "editInputCell", - "filterIcon", - "footerContainer", - "iconButtonContainer", - "iconSeparator", - "main", - "menu", - "menuIcon", - "menuIconButton", - "menuOpen", - "menuList", - "overlay", - "virtualScroller", - "virtualScrollerContent", - "virtualScrollerContent--overflowed", - "virtualScrollerRenderZone", - "pinnedColumns", - "pinnedColumns--left", - "pinnedColumns--right", - "pinnedColumnHeaders", - "pinnedColumnHeaders--left", - "pinnedColumnHeaders--right", - "root", - "row--editable", - "row--editing", - "row--lastVisible", - "row", - "rowCount", - "scrollArea", - "scrollArea--left", - "scrollArea--right", - "selectedRowCount", - "sortIcon", - "toolbarContainer", - "toolbarFilterList", - "withBorder", - "treeDataGroupingCell", - "treeDataGroupingCellToggle", - "groupingCriteriaCell", - "groupingCriteriaCellToggle" - ], - "globalClasses": {}, - "name": "MuiDataGrid" - }, - "forwardsRefTo": "GridRoot", - "filename": "/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx", - "demos": "" -} diff --git a/docs/pages/api-docs/data-grid/grid-api.js b/docs/pages/api-docs/data-grid/grid-api.js deleted file mode 100644 index 8f347e6028ca..000000000000 --- a/docs/pages/api-docs/data-grid/grid-api.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-api.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-api.md b/docs/pages/api-docs/data-grid/grid-api.md deleted file mode 100644 index 0726d5e251a5..000000000000 --- a/docs/pages/api-docs/data-grid/grid-api.md +++ /dev/null @@ -1,116 +0,0 @@ -# GridApi Interface - -

The full grid API.

- -## Import - -```js -import { GridApi } from '@mui/x-data-grid-pro'; -``` - -## Properties - -| Name | Type | Description | -| :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| addRowGroupingCriteria [](https://mui.com/store/items/material-ui-pro/) | (groupingCriteriaField: string, groupingIndex?: number) => void | Adds the field to the row grouping model. | -| applySorting | () => void | Applies the current sort model to the rows. | -| commitCellChange | (params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean \| Promise<boolean> | Updates the field corresponding to the given id with the value stored in the edit row model. | -| commitRowChange | (id: GridRowId, event?: MuiBaseEvent) => boolean \| Promise<boolean> | Updates the row corresponding to the given id with the values stored in the edit row model. | -| deleteFilterItem | (item: GridFilterItem) => void | Deletes a [GridFilterItem](/api/data-grid/grid-filter-item/). | -| exportDataAsCsv | (options?: GridCsvExportOptions) => void | Downloads and exports a CSV of the grid's data. | -| exportDataAsPrint | (options?: GridPrintExportOptions) => void | Print the grid's data. | -| exportState | () => InitialState | Generates a serializable object containing the exportable parts of the DataGrid state.
These values can then be passed to the `initialState` prop or injected using the `restoreState` method. | -| forceUpdate | () => void | Forces the grid to rerender. It's often used after a state update. | -| getAllColumns | () => GridStateColDef[] | Returns an array of [GridColDef](/api/data-grid/grid-col-def/) containing all the column definitions. | -| getAllRowIds | () => GridRowId[] | Gets the list of row ids. | -| getCellElement | (id: GridRowId, field: string) => HTMLDivElement \| null | Gets the underlying DOM element for a cell at the given `id` and `field`. | -| getCellMode | (id: GridRowId, field: string) => GridCellMode | Gets the mode of a cell. | -| getCellParams | <V = any, R extends GridValidRowModel = any, F = V>(id: GridRowId, field: string) => GridCellParams<R, V, F> | Gets the [GridCellParams](/api/data-grid/grid-cell-params/) object that is passed as argument in events. | -| getCellValue | <V extends any = any>(id: GridRowId, field: string) => V | Gets the value of a cell at the given `id` and `field`. | -| getColumn | (field: string) => GridStateColDef | Returns the [GridColDef](/api/data-grid/grid-col-def/) for the given `field`. | -| getColumnHeaderElement | (field: string) => HTMLDivElement \| null | Gets the underlying DOM element for the column header with the given `field`. | -| getColumnHeaderParams | (field: string) => GridColumnHeaderParams | Gets the GridColumnHeaderParams object that is passed as argument in events. | -| getColumnIndex | (field: string, useVisibleColumns?: boolean) => number | Returns the index position of a column. By default, only the visible columns are considered.
Pass `false` to `useVisibleColumns` to consider all columns. | -| getColumnPosition | (field: string) => number | Returns the left-position of a column relative to the inner border of the grid. | -| getColumnsMeta | () => GridColumnsMeta | Returns the GridColumnsMeta for each column. | -| getDataAsCsv | (options?: GridCsvExportOptions) => string | Returns the grid data as a CSV string.
This method is used internally by `exportDataAsCsv`. | -| getEditRowsModel | () => GridEditRowsModel | Gets the edit rows model of the grid. | -| getExpandedDetailPanels [](https://mui.com/store/items/material-ui-pro/) | () => GridRowId[] | Returns the rows whose detail panel is open. | -| getLocaleText | <T extends GridTranslationKeys>(key: T) => GridLocaleText[T] | Returns the translation for the `key`. | -| getPinnedColumns [](https://mui.com/store/items/material-ui-pro/) | () => GridPinnedColumns | Returns which columns are pinned. | -| getRootDimensions | () => GridDimensions \| null | Returns the dimensions of the grid | -| getRow | <R extends GridValidRowModel = any>(id: GridRowId) => R \| null | Gets the row data with a given id. | -| getRowElement | (id: GridRowId) => HTMLDivElement \| null | Gets the underlying DOM element for a row at the given `id`. | -| getRowIdFromRowIndex | (index: number) => GridRowId | Gets the `GridRowId` of a row at a specific index.
The index is based on the sorted but unfiltered row list. | -| getRowIndex | (id: GridRowId) => number | Gets the row index of a row with a given id.
The index is based on the sorted but unfiltered row list. | -| getRowIndexRelativeToVisibleRows | (id: GridRowId) => number | Gets the index of a row relative to the rows that are reachable by scroll. | -| getRowMode | (id: GridRowId) => GridRowMode | Gets the mode of a row. | -| getRowModels | () => Map<GridRowId, GridRowModel> | Gets the full set of rows as Map<GridRowId, GridRowModel>. | -| getRowNode | (id: GridRowId) => GridRowTreeNodeConfig \| null | Gets the row node from the internal tree structure. | -| getRowParams | (id: GridRowId) => GridRowParams | Gets the [GridRowParams](/api/data-grid/grid-row-params/) object that is passed as argument in events. | -| getRowsCount | () => number | Gets the total number of rows in the grid. | -| getScrollPosition | () => GridScrollParams | Returns the current scroll position. | -| getSelectedRows | () => Map<GridRowId, GridRowModel> | Returns an array of the selected rows. | -| getSortedRowIds | () => GridRowId[] | Returns all row ids sorted according to the active sort model. | -| getSortedRows | () => GridRowModel[] | Returns all rows sorted according to the active sort model. | -| getSortModel | () => GridSortModel | Returns the sort model currently applied to the grid. | -| getVisibleColumns | () => GridStateColDef[] | Returns the currently visible columns. | -| getVisibleRowModels | () => Map<GridRowId, GridRowModel> | Returns a sorted `Map` containing only the visible rows. | -| hideColumnMenu | () => void | Hides the column menu that is open. | -| hideFilterPanel | () => void | Hides the filter panel. | -| hidePreferences | () => void | Hides the preferences panel. | -| isCellEditable | (params: GridCellParams) => boolean | Controls if a cell is editable. | -| isColumnPinned [](https://mui.com/store/items/material-ui-pro/) | (field: string) => GridPinnedPosition \| false | Returns which side a column is pinned to. | -| isRowSelected | (id: GridRowId) => boolean | Determines if a row is selected or not. | -| pinColumn [](https://mui.com/store/items/material-ui-pro/) | (field: string, side: GridPinnedPosition) => void | Pins a column to the left or right side of the grid. | -| publishEvent | GridEventPublisher | Emits an event. | -| removeRowGroupingCriteria [](https://mui.com/store/items/material-ui-pro/) | (groupingCriteriaField: string) => void | sRemove the field from the row grouping model. | -| resize | () => void | Triggers a resize of the component and recalculation of width and height. | -| restoreState | (stateToRestore: InitialState) => void | Inject the given values into the state of the DataGrid. | -| scroll | (params: Partial<GridScrollParams>) => void | Triggers the viewport to scroll to the given positions (in pixels). | -| scrollToIndexes | (params: Partial<GridCellIndexCoordinates>) => boolean | Triggers the viewport to scroll to the cell at indexes given by `params`.
Returns `true` if the grid had to scroll to reach the target. | -| selectRow | (id: GridRowId, isSelected?: boolean, resetSelection?: boolean) => void | Change the selection state of a row. | -| selectRowRange | (range: { startId: GridRowId; endId: GridRowId }, isSelected?: boolean, resetSelection?: boolean) => void | Change the selection state of all the selectable rows in a range. | -| selectRows | (ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void | Change the selection state of multiple rows. | -| setCellFocus | (id: GridRowId, field: string) => void | Sets the focus to the cell at the given `id` and `field`. | -| setCellMode | (id: GridRowId, field: string, mode: GridCellMode) => void | Sets the mode of a cell. | -| setColumnHeaderFocus | (field: string, event?: MuiBaseEvent) => void | Sets the focus to the column header at the given `field`. | -| setColumnIndex | (field: string, targetIndexPosition: number) => void | Moves a column from its original position to the position given by `targetIndexPosition`. | -| setColumnVisibility | (field: string, isVisible: boolean) => void | Changes the visibility of the column referred by `field`. | -| setColumnVisibilityModel | (model: GridColumnVisibilityModel) => void | Sets the column visibility model to the one given by `model`. | -| setColumnWidth | (field: string, width: number) => void | Updates the width of a column. | -| setDensity | (density: GridDensity, headerHeight?: number, rowHeight?: number) => void | Sets the density of the grid. | -| setEditCellValue | (params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise<boolean> \| void | Sets the value of the edit cell.
Commonly used inside the edit cell component. | -| setEditRowsModel | (model: GridEditRowsModel) => void | Set the edit rows model of the grid. | -| setExpandedDetailPanels [](https://mui.com/store/items/material-ui-pro/) | (ids: GridRowId[]) => void | Changes which rows to expand the detail panel. | -| setFilterLinkOperator | (operator: GridLinkOperator) => void | Changes the GridLinkOperator used to connect the filters. | -| setFilterModel | (model: GridFilterModel) => void | Sets the filter model to the one given by `model`. | -| setPage | (page: number) => void | Sets the displayed page to the value given by `page`. | -| setPageSize | (pageSize: number) => void | Sets the number of displayed rows to the value given by `pageSize`. | -| setPinnedColumns [](https://mui.com/store/items/material-ui-pro/) | (pinnedColumns: GridPinnedColumns) => void | Changes the pinned columns. | -| setRowChildrenExpansion | (id: GridRowId, isExpanded: boolean) => void | Expand or collapse a row children. | -| setRowGroupingCriteriaIndex [](https://mui.com/store/items/material-ui-pro/) | (groupingCriteriaField: string, groupingIndex: number) => void | Sets the grouping index of a grouping criteria. | -| setRowGroupingModel [](https://mui.com/store/items/material-ui-pro/) | (model: GridRowGroupingModel) => void | Sets the columns to use as grouping criteria. | -| setRowMode | (id: GridRowId, mode: GridRowMode) => void | Sets the mode of a row. | -| setRows | (rows: GridRowModel[]) => void | Sets a new set of rows. | -| setSelectionModel | (rowIds: GridRowId[]) => void | Updates the selected rows to be those passed to the `rowIds` argument.
Any row already selected will be unselected. | -| setSortModel | (model: GridSortModel) => void | Updates the sort model and triggers the sorting of rows. | -| showColumnMenu | (field: string) => void | Display the column menu under the `field` column. | -| showError | (props: any) => void | Displays the error overlay component. | -| showFilterPanel | (targetColumnField?: string) => void | Shows the filter panel. If `targetColumnField` is given, a filter for this field is also added. | -| showPreferences | (newValue: GridPreferencePanelsValue) => void | Displays the preferences panel. The `newValue` argument controls the content of the panel. | -| sortColumn | (column: GridColDef, direction?: GridSortDirection, allowMultipleSorting?: boolean) => void | Sorts a column. | -| startCellEditMode | any | Puts the cell corresponding to the given row id and field into edit mode. | -| startRowEditMode | any | Puts the row corresponding to the given id into edit mode. | -| state | State | Property that contains the whole state of the grid. | -| stopCellEditMode | any | Puts the cell corresponding to the given row id and field into view mode and updates the original row with the new value stored.
If `params.ignoreModifications` is `false` it will discard the modifications made. | -| stopRowEditMode | any | Puts the row corresponding to the given id and into view mode and updates the original row with the new values stored.
If `params.ignoreModifications` is `false` it will discard the modifications made. | -| subscribeEvent | <E extends GridEventsStr>(event: E, handler: GridEventListener<E>, options?: EventListenerOptions) => () => void | Registers a handler for an event. | -| toggleColumnMenu | (field: string) => void | Toggles the column menu under the `field` column. | -| toggleDetailPanel [](https://mui.com/store/items/material-ui-pro/) | (id: GridRowId) => void | Expands or collapses the detail panel of a row. | -| unpinColumn [](https://mui.com/store/items/material-ui-pro/) | (field: string) => void | Unpins a column. | -| unstable_moveFocusToRelativeCell | (id: GridRowId, field: string, direction: 'below' \| 'right' \| 'left') => void | Moves the focus to the cell situated at the given direction.
If field is the last and direction=right, the focus goes to the next row.
If field is the first and direction=left, the focus goes to the previous row. | -| updateColumn | (col: GridColDef) => void | Updates the definition of a column. | -| updateColumns | (cols: GridColDef[]) => void | Updates the definition of multiple columns at the same time. | -| updateRows | (updates: GridRowModelUpdate[]) => void | Allows to updates, insert and delete rows in a single call. | -| upsertFilterItem | (item: GridFilterItem) => void | Updates or inserts a [GridFilterItem](/api/data-grid/grid-filter-item/). | diff --git a/docs/pages/api-docs/data-grid/grid-cell-params.js b/docs/pages/api-docs/data-grid/grid-cell-params.js deleted file mode 100644 index e64d6d9e2d59..000000000000 --- a/docs/pages/api-docs/data-grid/grid-cell-params.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-cell-params.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-cell-params.md b/docs/pages/api-docs/data-grid/grid-cell-params.md deleted file mode 100644 index 3f67a45ba221..000000000000 --- a/docs/pages/api-docs/data-grid/grid-cell-params.md +++ /dev/null @@ -1,28 +0,0 @@ -# GridCellParams Interface - -

Object passed as parameter in the column GridColDef cell renderer.

- -## Import - -```js -import { GridCellParams } from '@mui/x-data-grid-pro'; -// or -import { GridCellParams } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Description | -| :------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- | :--------------------------------------------------------------- | -| cellMode | GridCellMode | The mode of the cell. | -| colDef | GridStateColDef | The column of the row that the current cell belongs to. | -| field | string | The column field of the cell that triggered the event. | -| formattedValue | F | The cell value formatted with the column valueFormatter. | -| getValue | (id: GridRowId, field: string) => any | Get the cell value of a row and field. | -| hasFocus | boolean | If true, the cell is the active element. | -| id | GridRowId | The grid row id. | -| isEditable? | boolean | If true, the cell is editable. | -| row | GridRowModel<R> | The row model of the row that the current cell belongs to. | -| rowNode | GridRowTreeNodeConfig | The node of the row that the current cell belongs to. | -| tabIndex | 0 \| -1 | the tabIndex value. | -| value | V \| undefined | The cell value, but if the column has valueGetter, use getValue. | diff --git a/docs/pages/api-docs/data-grid/grid-col-def.js b/docs/pages/api-docs/data-grid/grid-col-def.js deleted file mode 100644 index f2a2056bef05..000000000000 --- a/docs/pages/api-docs/data-grid/grid-col-def.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-col-def.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-col-def.md b/docs/pages/api-docs/data-grid/grid-col-def.md deleted file mode 100644 index 6d51eda8058a..000000000000 --- a/docs/pages/api-docs/data-grid/grid-col-def.md +++ /dev/null @@ -1,52 +0,0 @@ -# GridColDef Interface - -

Column Definition interface.

- -## Import - -```js -import { GridColDef } from '@mui/x-data-grid-pro'; -// or -import { GridColDef } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Default | Description | -| :-------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | -| align? | GridAlignment | | Allows to align the column values in cells. | -| cellClassName? | GridCellClassNamePropType | | Class name that will be added in cells for that column. | -| description? | string | | The description of the column rendered as tooltip if the column header name is not fully displayed. | -| disableColumnMenu? | boolean | false | If `true`, the column menu is disabled for this column. | -| disableExport? | boolean | false | If `true`, this column will not be included in exports. | -| disableReorder? | boolean | false | If `true`, this column cannot be reordered. | -| editable? | boolean | false | If `true`, the cells of the column are editable. | -| field | string | | The column identifier. It's used to map with GridRowModel values. | -| filterable? | boolean | true | If `true`, the column is filterable. | -| filterOperators? | GridFilterOperator<R, V, F>[] | | Allows setting the filter operators for this column. | -| flex? | number | | If set, it indicates that a column has fluid width. Range [0, โˆž). | -| groupable? | boolean | true | If `true`, the rows can be grouped based on this column values (pro-plan only). | -| headerAlign? | GridAlignment | | Header cell element alignment. | -| headerClassName? | GridColumnHeaderClassNamePropType | | Class name that will be added in the column header cell. | -| headerName? | string | | The title of the column rendered in the column header cell. | -| hide? | boolean | false | If `true`, hide the column. | -| hideable? | boolean | true | If `false`, removes the buttons for hiding this column. | -| hideSortIcons? | boolean | false | Toggle the visibility of the sort icons. | -| maxWidth? | number | Infinity | Sets the maximum width of a column. | -| minWidth? | number | 50 | Sets the minimum width of a column. | -| pinnable? | boolean | true | If `false`, the menu items for column pinning menu will not be rendered.
Only available in DataGridPro. | -| preProcessEditCellProps? | (params: GridPreProcessEditCellProps) => GridEditCellProps \| Promise<GridEditCellProps> | | Callback fired when the edit props of the cell changes.
It allows to process the props that saved into the state. | -| renderCell? | (params: GridRenderCellParams<V, R, F>) => React.ReactNode | | Allows to override the component rendered as cell for this column. | -| renderEditCell? | (params: GridRenderEditCellParams<V>) => React.ReactNode | | Allows to override the component rendered in edit cell mode for this column. | -| renderHeader? | (params: GridColumnHeaderParams<V, R, F>) => React.ReactNode | | Allows to render a component in the column header cell. | -| resizable? | boolean | true | If `true`, the column is resizable. | -| sortable? | boolean | true | If `true`, the column is sortable. | -| sortComparator? | GridComparatorFn<V> | | A comparator function used to sort rows. | -| sortingOrder? | GridSortDirection[] | | The order of the sorting sequence. | -| type? | GridColType | 'string' | Type allows to merge this object with a default definition [GridColDef](/api/data-grid/grid-col-def/). | -| valueFormatter? | (params: GridValueFormatterParams<V>) => F | | Function that allows to apply a formatter before rendering its value. | -| valueGetter? | (params: GridValueGetterParams<any, R>) => V | | Function that allows to get a specific data instead of field to render in the cell. | -| valueOptions? | Array<ValueOptions> \| ((params: GridValueOptionsParams<R>) => Array<ValueOptions>) | | To be used in combination with `type: 'singleSelect'`. This is an array (or a function returning an array) of the possible cell values and labels. | -| valueParser? | (value: F \| undefined, params?: GridCellParams<V, R, F>) => V | | Function that takes the user-entered value and converts it to a value used internally. | -| valueSetter? | (params: GridValueSetterParams<R, V>) => R | | Function that allows to customize how the entered value is stored in the row.
It only works with cell/row editing. | -| width? | number | 100 | Set the width of the column. | diff --git a/docs/pages/api-docs/data-grid/grid-column-pinning-api.json b/docs/pages/api-docs/data-grid/grid-column-pinning-api.json deleted file mode 100644 index ca096a53f413..000000000000 --- a/docs/pages/api-docs/data-grid/grid-column-pinning-api.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "name": "GridColumnPinningApi", - "description": "The column pinning API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "getPinnedColumns", - "description": "Returns which columns are pinned.", - "type": "() => GridPinnedColumns" - }, - { - "name": "isColumnPinned", - "description": "Returns which side a column is pinned to.", - "type": "(field: string) => GridPinnedPosition | false" - }, - { - "name": "pinColumn", - "description": "Pins a column to the left or right side of the grid.", - "type": "(field: string, side: GridPinnedPosition) => void" - }, - { - "name": "setPinnedColumns", - "description": "Changes the pinned columns.", - "type": "(pinnedColumns: GridPinnedColumns) => void" - }, - { "name": "unpinColumn", "description": "Unpins a column.", "type": "(field: string) => void" } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-csv-export-api.json b/docs/pages/api-docs/data-grid/grid-csv-export-api.json deleted file mode 100644 index 7956fdd428dd..000000000000 --- a/docs/pages/api-docs/data-grid/grid-csv-export-api.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "name": "GridCsvExportApi", - "description": "The CSV export API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "exportDataAsCsv", - "description": "Downloads and exports a CSV of the grid's data.", - "type": "(options?: GridCsvExportOptions) => void" - }, - { - "name": "getDataAsCsv", - "description": "Returns the grid data as a CSV string.\nThis method is used internally by exportDataAsCsv.", - "type": "(options?: GridCsvExportOptions) => string" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-csv-export-options.js b/docs/pages/api-docs/data-grid/grid-csv-export-options.js deleted file mode 100644 index 5cddb9c15182..000000000000 --- a/docs/pages/api-docs/data-grid/grid-csv-export-options.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-csv-export-options.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-csv-export-options.md b/docs/pages/api-docs/data-grid/grid-csv-export-options.md deleted file mode 100644 index 5130891e1716..000000000000 --- a/docs/pages/api-docs/data-grid/grid-csv-export-options.md +++ /dev/null @@ -1,23 +0,0 @@ -# GridCsvExportOptions Interface - -

The options to apply on the CSV export.

- -## Import - -```js -import { GridCsvExportOptions } from '@mui/x-data-grid-pro'; -// or -import { GridCsvExportOptions } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Default | Description | -| :------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------- | :------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------- | -| allColumns? | boolean | false | If `true`, the hidden columns will also be exported. | -| delimiter? | string | ',' | The character used to separate fields. | -| fields? | string[] | | The columns exported.
This should only be used if you want to restrict the columns exports. | -| fileName? | string | `document.title` | The string used as the file name. | -| getRowsToExport? | (params: GridCsvGetRowsToExportParams) => GridRowId[] | | Function that returns the id of the rows to export on the order they should be exported. | -| includeHeaders? | boolean | true | If `true`, the first row of the CSV will include the headers of the grid. | -| utf8WithBom? | boolean | false | If `true`, the UTF-8 Byte Order Mark (BOM) prefixes the exported file.
This can allow Excel to automatically detect file encoding as UTF-8. | diff --git a/docs/pages/api-docs/data-grid/grid-detail-panel-api.json b/docs/pages/api-docs/data-grid/grid-detail-panel-api.json deleted file mode 100644 index 56633cb86b2d..000000000000 --- a/docs/pages/api-docs/data-grid/grid-detail-panel-api.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "name": "GridDetailPanelApi", - "description": "The master/detail API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "getExpandedDetailPanels", - "description": "Returns the rows whose detail panel is open.", - "type": "() => GridRowId[]" - }, - { - "name": "setExpandedDetailPanels", - "description": "Changes which rows to expand the detail panel.", - "type": "(ids: GridRowId[]) => void" - }, - { - "name": "toggleDetailPanel", - "description": "Expands or collapses the detail panel of a row.", - "type": "(id: GridRowId) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-disable-virtualization-api.json b/docs/pages/api-docs/data-grid/grid-disable-virtualization-api.json deleted file mode 100644 index cfd81012d2b7..000000000000 --- a/docs/pages/api-docs/data-grid/grid-disable-virtualization-api.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "name": "GridDisableVirtualizationApi", - "description": "The API to disable the virtualization that is available in the grid apiRef.", - "properties": [] -} diff --git a/docs/pages/api-docs/data-grid/grid-edit-row-api.json b/docs/pages/api-docs/data-grid/grid-edit-row-api.json deleted file mode 100644 index 6232b0b23480..000000000000 --- a/docs/pages/api-docs/data-grid/grid-edit-row-api.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "name": "GridEditRowApi", - "description": "The editing API interface that is available in the grid `apiRef`.", - "properties": [ - { - "name": "commitCellChange", - "description": "Updates the field at the given id with the value stored in the edit row model.", - "type": "(params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean | Promise" - }, - { - "name": "commitRowChange", - "description": "Updates the row at the given id with the values stored in the edit row model.", - "type": "(id: GridRowId, event?: MuiBaseEvent) => boolean | Promise" - }, - { - "name": "getCellMode", - "description": "Gets the mode of a cell.", - "type": "(id: GridRowId, field: string) => GridCellMode" - }, - { - "name": "getEditRowsModel", - "description": "Gets the edit rows model of the grid.", - "type": "() => GridEditRowsModel" - }, - { - "name": "getRowMode", - "description": "Gets the mode of a row.", - "type": "(id: GridRowId) => GridRowMode" - }, - { - "name": "isCellEditable", - "description": "Controls if a cell is editable.", - "type": "(params: GridCellParams) => boolean" - }, - { - "name": "setCellMode", - "description": "Sets the mode of a cell.", - "type": "(id: GridRowId, field: string, mode: GridCellMode) => void" - }, - { - "name": "setEditCellValue", - "description": "Sets the value of the edit cell.\nCommonly used inside the edit cell component.", - "type": "(params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise | void" - }, - { - "name": "setEditRowsModel", - "description": "Set the edit rows model of the grid.", - "type": "(model: GridEditRowsModel) => void" - }, - { - "name": "setRowMode", - "description": "Sets the mode of a row.", - "type": "(id: GridRowId, mode: GridRowMode) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-editing-api.json b/docs/pages/api-docs/data-grid/grid-editing-api.json deleted file mode 100644 index a7b804b7f078..000000000000 --- a/docs/pages/api-docs/data-grid/grid-editing-api.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "name": "GridEditingApi", - "description": "The editing API interface that is available in the grid `apiRef`.", - "properties": [ - { - "name": "commitCellChange", - "description": "Updates the field corresponding to the given id with the value stored in the edit row model.", - "type": "(params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean | Promise" - }, - { - "name": "commitRowChange", - "description": "Updates the row corresponding to the given id with the values stored in the edit row model.", - "type": "(id: GridRowId, event?: MuiBaseEvent) => boolean | Promise" - }, - { - "name": "getCellMode", - "description": "Gets the mode of a cell.", - "type": "(id: GridRowId, field: string) => GridCellMode" - }, - { - "name": "getEditRowsModel", - "description": "Gets the edit rows model of the grid.", - "type": "() => GridEditRowsModel" - }, - { - "name": "getRowMode", - "description": "Gets the mode of a row.", - "type": "(id: GridRowId) => GridRowMode" - }, - { - "name": "isCellEditable", - "description": "Controls if a cell is editable.", - "type": "(params: GridCellParams) => boolean" - }, - { - "name": "setCellMode", - "description": "Sets the mode of a cell.", - "type": "(id: GridRowId, field: string, mode: GridCellMode) => void" - }, - { - "name": "setEditCellValue", - "description": "Sets the value of the edit cell.\nCommonly used inside the edit cell component.", - "type": "(params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise | void" - }, - { - "name": "setEditRowsModel", - "description": "Set the edit rows model of the grid.", - "type": "(model: GridEditRowsModel) => void" - }, - { - "name": "setRowMode", - "description": "Sets the mode of a row.", - "type": "(id: GridRowId, mode: GridRowMode) => void" - }, - { - "name": "startCellEditMode", - "description": "Puts the cell corresponding to the given row id and field into edit mode.", - "type": "(params: GridStartCellEditModeParams) => void" - }, - { - "name": "startRowEditMode", - "description": "Puts the row corresponding to the given id into edit mode.", - "type": "(params: GridStartRowEditModeParams) => void" - }, - { - "name": "stopCellEditMode", - "description": "Puts the cell corresponding to the given row id and field into view mode and updates the original row with the new value stored.\nIf params.ignoreModifications is false it will discard the modifications made.", - "type": "(params: GridStopCellEditModeParams) => void" - }, - { - "name": "stopRowEditMode", - "description": "Puts the row corresponding to the given id and into view mode and updates the original row with the new values stored.\nIf params.ignoreModifications is false it will discard the modifications made.", - "type": "(params: GridStopRowEditModeParams) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-filter-api.json b/docs/pages/api-docs/data-grid/grid-filter-api.json deleted file mode 100644 index a3518180829e..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-api.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "name": "GridFilterApi", - "description": "The filter API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "deleteFilterItem", - "description": "Deletes a GridFilterItem.", - "type": "(item: GridFilterItem) => void" - }, - { - "name": "getVisibleRowModels", - "description": "Returns a sorted Map containing only the visible rows.", - "type": "() => Map" - }, - { "name": "hideFilterPanel", "description": "Hides the filter panel.", "type": "() => void" }, - { - "name": "setFilterLinkOperator", - "description": "Changes the GridLinkOperator used to connect the filters.", - "type": "(operator: GridLinkOperator) => void" - }, - { - "name": "setFilterModel", - "description": "Sets the filter model to the one given by model.", - "type": "(model: GridFilterModel) => void" - }, - { - "name": "showFilterPanel", - "description": "Shows the filter panel. If targetColumnField is given, a filter for this field is also added.", - "type": "(targetColumnField?: string) => void" - }, - { - "name": "upsertFilterItem", - "description": "Updates or inserts a GridFilterItem.", - "type": "(item: GridFilterItem) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-filter-item.js b/docs/pages/api-docs/data-grid/grid-filter-item.js deleted file mode 100644 index 5155144ea50e..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-item.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-filter-item.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-filter-item.md b/docs/pages/api-docs/data-grid/grid-filter-item.md deleted file mode 100644 index d1d6bdf7a5fa..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-item.md +++ /dev/null @@ -1,20 +0,0 @@ -# GridFilterItem Interface - -

Filter item definition interface.

- -## Import - -```js -import { GridFilterItem } from '@mui/x-data-grid-pro'; -// or -import { GridFilterItem } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Description | -| :---------------------------------------------------------------------------------------------- | :---------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | -| columnField | string | The column from which we want to filter the rows. | -| id? | number \| string | Must be unique.
Only useful when the model contains several items. | -| operatorValue? | string | The name of the operator we want to apply.
Will become required on `@mui/x-data-grid@6.X`. | -| value? | any | The filtering value.
The operator filtering function will decide for each row if the row values is correct compared to this value. | diff --git a/docs/pages/api-docs/data-grid/grid-filter-model.js b/docs/pages/api-docs/data-grid/grid-filter-model.js deleted file mode 100644 index 61239d3ad426..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-model.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-filter-model.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-filter-model.md b/docs/pages/api-docs/data-grid/grid-filter-model.md deleted file mode 100644 index 5f64fb106186..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-model.md +++ /dev/null @@ -1,18 +0,0 @@ -# GridFilterModel Interface - -

Model describing the filters to apply to the grid.

- -## Import - -```js -import { GridFilterModel } from '@mui/x-data-grid-pro'; -// or -import { GridFilterModel } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Default | Description | -| :--------------------------------------------------------------------------------------------- | :---------------------------------------------- | :------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------- | -| items | GridFilterItem[] | [] | | -| linkOperator? | GridLinkOperator | `GridLinkOperator.Or` | - `GridLinkOperator.And`: the row must pass all the filter items.
- `GridLinkOperator.Or`: the row must pass at least on filter item. | diff --git a/docs/pages/api-docs/data-grid/grid-filter-operator.js b/docs/pages/api-docs/data-grid/grid-filter-operator.js deleted file mode 100644 index 2cbd12ae534e..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-operator.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-filter-operator.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-filter-operator.md b/docs/pages/api-docs/data-grid/grid-filter-operator.md deleted file mode 100644 index d0fdece2d67c..000000000000 --- a/docs/pages/api-docs/data-grid/grid-filter-operator.md +++ /dev/null @@ -1,21 +0,0 @@ -# GridFilterOperator Interface - -

Filter operator definition interface.

- -## Import - -```js -import { GridFilterOperator } from '@mui/x-data-grid-pro'; -// or -import { GridFilterOperator } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Description | -| :---------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| getApplyFilterFn | (filterItem: GridFilterItem, column: GridStateColDef<R, V, F>) => null \| ((params: GridCellParams<V, R, F>) => boolean) | The callback that generates a filtering function for a given filter item and column.
This function can return `null` to skip filtering for this item and column. | -| InputComponent? | React.JSXElementConstructor<GridFilterInputValueProps> \| React.JSXElementConstructor<GridFilterInputMultipleValueProps> \| React.JSXElementConstructor<GridFilterInputMultipleSingleSelectProps> | The input component to render in the filter panel for this filter operator. | -| InputComponentProps? | Record<string, any> | The props to pass to the input component in the filter panel for this filter operator. | -| label? | string | The label of the filter operator. | -| value | string | The name of the filter operator.
It will be matched with the `operatorValue` property of the filter items. | diff --git a/docs/pages/api-docs/data-grid/grid-new-editing-api.json b/docs/pages/api-docs/data-grid/grid-new-editing-api.json deleted file mode 100644 index 2bc716268ed4..000000000000 --- a/docs/pages/api-docs/data-grid/grid-new-editing-api.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "name": "GridNewEditingApi", - "description": "", - "properties": [ - { - "name": "getCellMode", - "description": "Gets the mode of a cell.", - "type": "(id: GridRowId, field: string) => GridCellMode" - }, - { - "name": "getRowMode", - "description": "Gets the mode of a row.", - "type": "(id: GridRowId) => GridRowMode" - }, - { - "name": "isCellEditable", - "description": "Controls if a cell is editable.", - "type": "(params: GridCellParams) => boolean" - }, - { - "name": "setEditCellValue", - "description": "Sets the value of the edit cell.\nCommonly used inside the edit cell component.", - "type": "(params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise | void" - }, - { - "name": "startCellEditMode", - "description": "Puts the cell corresponding to the given row id and field into edit mode.", - "type": "(params: GridStartCellEditModeParams) => void" - }, - { - "name": "startRowEditMode", - "description": "Puts the row corresponding to the given id into edit mode.", - "type": "(params: GridStartRowEditModeParams) => void" - }, - { - "name": "stopCellEditMode", - "description": "Puts the cell corresponding to the given row id and field into view mode and updates the original row with the new value stored.\nIf params.ignoreModifications is false it will discard the modifications made.", - "type": "(params: GridStopCellEditModeParams) => void" - }, - { - "name": "stopRowEditMode", - "description": "Puts the row corresponding to the given id and into view mode and updates the original row with the new values stored.\nIf params.ignoreModifications is false it will discard the modifications made.", - "type": "(params: GridStopRowEditModeParams) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-old-editing-api.json b/docs/pages/api-docs/data-grid/grid-old-editing-api.json deleted file mode 100644 index 04fe3c25a868..000000000000 --- a/docs/pages/api-docs/data-grid/grid-old-editing-api.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "name": "GridOldEditingApi", - "description": "", - "properties": [ - { - "name": "commitCellChange", - "description": "Updates the field corresponding to the given id with the value stored in the edit row model.", - "type": "(params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean | Promise" - }, - { - "name": "commitRowChange", - "description": "Updates the row corresponding to the given id with the values stored in the edit row model.", - "type": "(id: GridRowId, event?: MuiBaseEvent) => boolean | Promise" - }, - { - "name": "getCellMode", - "description": "Gets the mode of a cell.", - "type": "(id: GridRowId, field: string) => GridCellMode" - }, - { - "name": "getEditRowsModel", - "description": "Gets the edit rows model of the grid.", - "type": "() => GridEditRowsModel" - }, - { - "name": "getRowMode", - "description": "Gets the mode of a row.", - "type": "(id: GridRowId) => GridRowMode" - }, - { - "name": "isCellEditable", - "description": "Controls if a cell is editable.", - "type": "(params: GridCellParams) => boolean" - }, - { - "name": "setCellMode", - "description": "Sets the mode of a cell.", - "type": "(id: GridRowId, field: string, mode: GridCellMode) => void" - }, - { - "name": "setEditCellValue", - "description": "Sets the value of the edit cell.\nCommonly used inside the edit cell component.", - "type": "(params: GridEditCellValueParams, event?: MuiBaseEvent) => Promise | void" - }, - { - "name": "setEditRowsModel", - "description": "Set the edit rows model of the grid.", - "type": "(model: GridEditRowsModel) => void" - }, - { - "name": "setRowMode", - "description": "Sets the mode of a row.", - "type": "(id: GridRowId, mode: GridRowMode) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-pagination-api.json b/docs/pages/api-docs/data-grid/grid-pagination-api.json deleted file mode 100644 index 901a63c88cab..000000000000 --- a/docs/pages/api-docs/data-grid/grid-pagination-api.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "name": "GridPaginationApi", - "description": "The pagination API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "setPage", - "description": "Sets the displayed page to the value given by page.", - "type": "(page: number) => void" - }, - { - "name": "setPageSize", - "description": "Sets the number of displayed rows to the value given by pageSize.", - "type": "(pageSize: number) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-print-export-api.json b/docs/pages/api-docs/data-grid/grid-print-export-api.json deleted file mode 100644 index c07b9c5c2bb5..000000000000 --- a/docs/pages/api-docs/data-grid/grid-print-export-api.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "name": "GridPrintExportApi", - "description": "The Print export API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "exportDataAsPrint", - "description": "Print the grid's data.", - "type": "(options?: GridPrintExportOptions) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-print-export-options.js b/docs/pages/api-docs/data-grid/grid-print-export-options.js deleted file mode 100644 index 5892b824047b..000000000000 --- a/docs/pages/api-docs/data-grid/grid-print-export-options.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-print-export-options.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-print-export-options.md b/docs/pages/api-docs/data-grid/grid-print-export-options.md deleted file mode 100644 index fe10816985f6..000000000000 --- a/docs/pages/api-docs/data-grid/grid-print-export-options.md +++ /dev/null @@ -1,24 +0,0 @@ -# GridPrintExportOptions Interface - -

The options to apply on the Print export.

- -## Import - -```js -import { GridPrintExportOptions } from '@mui/x-data-grid-pro'; -// or -import { GridPrintExportOptions } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Default | Description | -| :---------------------------------------------------------------------------------------------- | :------------------------------------------------ | :------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| allColumns? | boolean | false | If `true`, the hidden columns will also be exported. | -| bodyClassName? | string | | One or more classes passed to the print window. | -| copyStyles? | boolean | true | If `false`, all <style> and <link type="stylesheet" /> tags from the <head> will not be copied
to the print window. | -| fields? | string[] | | The columns exported.
This should only be used if you want to restrict the columns exports. | -| fileName? | string | The title of the page. | The value to be used as the print window title. | -| hideFooter? | boolean | false | If `true`, the footer is removed for when printing. | -| hideToolbar? | boolean | false | If `true`, the toolbar is removed for when printing. | -| pageStyle? | string \| Function | | Provide Print specific styles to the print window. | diff --git a/docs/pages/api-docs/data-grid/grid-row-class-name-params.js b/docs/pages/api-docs/data-grid/grid-row-class-name-params.js deleted file mode 100644 index 45ba69c0e60c..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-class-name-params.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-row-class-name-params.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-row-class-name-params.md b/docs/pages/api-docs/data-grid/grid-row-class-name-params.md deleted file mode 100644 index dae66bcad724..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-class-name-params.md +++ /dev/null @@ -1,23 +0,0 @@ -# GridRowClassNameParams Interface - -

Object passed as parameter in the row `getRowClassName` callback prop.

- -## Import - -```js -import { GridRowClassNameParams } from '@mui/x-data-grid-pro'; -// or -import { GridRowClassNameParams } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Description | -| :-------------------------------------------------------- | :---------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------- | -| columns | GridColumns | All grid columns. | -| getValue | (id: GridRowId, field: string) => any | Get the cell value of a row and field. | -| id | GridRowId | The grid row id. | -| indexRelativeToCurrentPage | number | Index of the row in the current page.
If the pagination is disabled, it will be the index relative to all filtered rows. | -| isFirstVisible | boolean | Whether this row is the first visible or not. | -| isLastVisible | boolean | Whether this row is the last visible or not. | -| row | R | The row model of the row that the current cell belongs to. | diff --git a/docs/pages/api-docs/data-grid/grid-row-grouping-api.json b/docs/pages/api-docs/data-grid/grid-row-grouping-api.json deleted file mode 100644 index 7d0865fc802a..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-grouping-api.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "name": "GridRowGroupingApi", - "description": "", - "properties": [ - { - "name": "addRowGroupingCriteria", - "description": "Adds the field to the row grouping model.", - "type": "(groupingCriteriaField: string, groupingIndex?: number) => void" - }, - { - "name": "removeRowGroupingCriteria", - "description": "sRemove the field from the row grouping model.", - "type": "(groupingCriteriaField: string) => void" - }, - { - "name": "setRowGroupingCriteriaIndex", - "description": "Sets the grouping index of a grouping criteria.", - "type": "(groupingCriteriaField: string, groupingIndex: number) => void" - }, - { - "name": "setRowGroupingModel", - "description": "Sets the columns to use as grouping criteria.", - "type": "(model: GridRowGroupingModel) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-row-params.js b/docs/pages/api-docs/data-grid/grid-row-params.js deleted file mode 100644 index cdf4f4a838e9..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-params.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-row-params.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-row-params.md b/docs/pages/api-docs/data-grid/grid-row-params.md deleted file mode 100644 index eea2072c834d..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-params.md +++ /dev/null @@ -1,20 +0,0 @@ -# GridRowParams Interface - -

Object passed as parameter in the row callbacks.

- -## Import - -```js -import { GridRowParams } from '@mui/x-data-grid-pro'; -// or -import { GridRowParams } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Description | -| :-------------------------------------- | :---------------------------------------------------------------------- | :--------------------------------------------------------- | -| columns | GridColumns | All grid columns. | -| getValue | (id: GridRowId, field: string) => any | Get the cell value of a row and field. | -| id | GridRowId | The grid row id. | -| row | R | The row model of the row that the current cell belongs to. | diff --git a/docs/pages/api-docs/data-grid/grid-row-spacing-params.js b/docs/pages/api-docs/data-grid/grid-row-spacing-params.js deleted file mode 100644 index e6f32fbc96b7..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-spacing-params.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from '@mui/monorepo/docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './grid-row-spacing-params.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/grid-row-spacing-params.md b/docs/pages/api-docs/data-grid/grid-row-spacing-params.md deleted file mode 100644 index 828bc621478a..000000000000 --- a/docs/pages/api-docs/data-grid/grid-row-spacing-params.md +++ /dev/null @@ -1,21 +0,0 @@ -# GridRowSpacingParams Interface - -

Object passed as parameter in the row `getRowSpacing` callback prop.

- -## Import - -```js -import { GridRowSpacingParams } from '@mui/x-data-grid-pro'; -// or -import { GridRowSpacingParams } from '@mui/x-data-grid'; -``` - -## Properties - -| Name | Type | Description | -| :-------------------------------------------------------- | :--------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------- | -| id | GridRowId | The row id. | -| indexRelativeToCurrentPage | number | Index of the row in the current page.
If the pagination is disabled, it will be the index relative to all filtered rows. | -| isFirstVisible | boolean | Whether this row is the first visible or not. | -| isLastVisible | boolean | Whether this row is the last visible or not. | -| model | R | The row model. | diff --git a/docs/pages/api-docs/data-grid/grid-scroll-api.json b/docs/pages/api-docs/data-grid/grid-scroll-api.json deleted file mode 100644 index cfcaa4da06a5..000000000000 --- a/docs/pages/api-docs/data-grid/grid-scroll-api.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "name": "GridScrollApi", - "description": "The scroll API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "getScrollPosition", - "description": "Returns the current scroll position.", - "type": "() => GridScrollParams" - }, - { - "name": "scroll", - "description": "Triggers the viewport to scroll to the given positions (in pixels).", - "type": "(params: Partial) => void" - }, - { - "name": "scrollToIndexes", - "description": "Triggers the viewport to scroll to the cell at indexes given by params.\nReturns true if the grid had to scroll to reach the target.", - "type": "(params: Partial) => boolean" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-selection-api.json b/docs/pages/api-docs/data-grid/grid-selection-api.json deleted file mode 100644 index 188b8d802cdb..000000000000 --- a/docs/pages/api-docs/data-grid/grid-selection-api.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "name": "GridSelectionApi", - "description": "The selection API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "getSelectedRows", - "description": "Returns an array of the selected rows.", - "type": "() => Map" - }, - { - "name": "isRowSelected", - "description": "Determines if a row is selected or not.", - "type": "(id: GridRowId) => boolean" - }, - { - "name": "selectRow", - "description": "Change the selection state of a row.", - "type": "(id: GridRowId, isSelected?: boolean, resetSelection?: boolean) => void" - }, - { - "name": "selectRowRange", - "description": "Change the selection state of all the selectable rows in a range.", - "type": "(range: { startId: GridRowId; endId: GridRowId }, isSelected?: boolean, resetSelection?: boolean) => void" - }, - { - "name": "selectRows", - "description": "Change the selection state of multiple rows.", - "type": "(ids: GridRowId[], isSelected?: boolean, resetSelection?: boolean) => void" - }, - { - "name": "setSelectionModel", - "description": "Updates the selected rows to be those passed to the rowIds argument.\nAny row already selected will be unselected.", - "type": "(rowIds: GridRowId[]) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/grid-sort-api.json b/docs/pages/api-docs/data-grid/grid-sort-api.json deleted file mode 100644 index 5684c9f42aaa..000000000000 --- a/docs/pages/api-docs/data-grid/grid-sort-api.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "name": "GridSortApi", - "description": "The sort API interface that is available in the grid apiRef.", - "properties": [ - { - "name": "applySorting", - "description": "Applies the current sort model to the rows.", - "type": "() => void" - }, - { - "name": "getRowIdFromRowIndex", - "description": "Gets the GridRowId of a row at a specific index.\nThe index is based on the sorted but unfiltered row list.", - "type": "(index: number) => GridRowId" - }, - { - "name": "getRowIndex", - "description": "Gets the row index of a row with a given id.\nThe index is based on the sorted but unfiltered row list.", - "type": "(id: GridRowId) => number" - }, - { - "name": "getSortedRowIds", - "description": "Returns all row ids sorted according to the active sort model.", - "type": "() => GridRowId[]" - }, - { - "name": "getSortedRows", - "description": "Returns all rows sorted according to the active sort model.", - "type": "() => GridRowModel[]" - }, - { - "name": "getSortModel", - "description": "Returns the sort model currently applied to the grid.", - "type": "() => GridSortModel" - }, - { - "name": "setSortModel", - "description": "Updates the sort model and triggers the sorting of rows.", - "type": "(model: GridSortModel) => void" - }, - { - "name": "sortColumn", - "description": "Sorts a column.", - "type": "(column: GridColDef, direction?: GridSortDirection, allowMultipleSorting?: boolean) => void" - } - ] -} diff --git a/docs/pages/api-docs/data-grid/index.js b/docs/pages/api-docs/data-grid/index.js deleted file mode 100644 index 029a56fd14ba..000000000000 --- a/docs/pages/api-docs/data-grid/index.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from './index.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/api-docs/data-grid/index.md b/docs/pages/api-docs/data-grid/index.md deleted file mode 100644 index 045c274b5cf5..000000000000 --- a/docs/pages/api-docs/data-grid/index.md +++ /dev/null @@ -1,26 +0,0 @@ -# Data Grid - API Reference - -

This page contains an index to the most important APIs of the data grid.

- -## Components - -- [DataGrid](/api/data-grid/data-grid/) -- [DataGridPro](/api/data-grid/data-grid-pro/) - -## Interfaces - -- [GridApi](/api/data-grid/grid-api/) -- [GridCellParams](/api/data-grid/grid-cell-params/) -- [GridColDef](/api/data-grid/grid-col-def/) -- [GridCsvExportOptions](/api/data-grid/grid-csv-export-options/) -- [GridFilterItem](/api/data-grid/grid-filter-item/) -- [GridFilterModel](/api/data-grid/grid-filter-model/) -- [GridFilterOperator](/api/data-grid/grid-filter-operator/) -- [GridPrintExportOptions](/api/data-grid/grid-print-export-options/) -- [GridRowClassNameParams](/api/data-grid/grid-row-class-name-params/) -- [GridRowParams](/api/data-grid/grid-row-params/) -- [GridRowSpacingParams](/api/data-grid/grid-row-spacing-params/) - -## Events - -- [Catalog](/components/data-grid/events/#catalog-of-events) diff --git a/docs/pages/api-docs/data-grid/selectors.json b/docs/pages/api-docs/data-grid/selectors.json deleted file mode 100644 index dc42a644c778..000000000000 --- a/docs/pages/api-docs/data-grid/selectors.json +++ /dev/null @@ -1,426 +0,0 @@ -[ - { - "name": "gridColumnDefinitionsSelector", - "returnType": "GridStateColDef[]", - "category": "Columns", - "description": "Get the columns as an array.", - "supportsApiRef": true - }, - { - "name": "gridColumnFieldsSelector", - "returnType": "string[]", - "category": "Columns", - "description": "Get the field of each column.", - "supportsApiRef": true - }, - { - "name": "gridColumnLookupSelector", - "returnType": "GridColumnLookup", - "category": "Columns", - "description": "Get the columns as a lookup (an object containing the field for keys and the definition for values).", - "supportsApiRef": true - }, - { - "name": "gridColumnMenuSelector", - "returnType": "GridColumnMenuState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridColumnPositionsSelector", - "returnType": "number[]", - "category": "Visible Columns", - "description": "Get the left position in pixel of each visible columns relative to the left of the first column.", - "supportsApiRef": true - }, - { - "name": "gridColumnReorderDragColSelector", - "returnType": "string", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridColumnReorderSelector", - "returnType": "GridColumnReorderState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridColumnResizeSelector", - "returnType": "GridColumnResizeState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridColumnVisibilityModelSelector", - "returnType": "GridColumnVisibilityModel", - "category": "Visible Columns", - "description": "Get the column visibility model, containing the visibility status of each column.\nIf a column is not registered in the model, it is visible.", - "supportsApiRef": true - }, - { - "name": "gridColumnsTotalWidthSelector", - "returnType": "number", - "category": "Visible Columns", - "description": "Get the summed width of all the visible columns.", - "supportsApiRef": true - }, - { - "name": "gridDensityFactorSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridDensityHeaderHeightSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridDensityRowHeightSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridDensitySelector", - "returnType": "GridDensityState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridDensityValueSelector", - "returnType": "GridDensity", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridDetailPanelExpandedRowIdsSelector", - "returnType": "GridRowId[]", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridDetailPanelExpandedRowsContentCacheSelector", - "returnType": "Record", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridDetailPanelExpandedRowsHeightCacheSelector", - "returnType": "Record", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridEditRowsStateSelector", - "returnType": "GridEditRowsModel", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridFilterModelSelector", - "returnType": "GridFilterModel", - "category": "Filtering", - "description": "Get the current filter model.", - "supportsApiRef": true - }, - { - "name": "gridFilterStateSelector", - "returnType": "GridFilterState", - "category": "Filtering", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridFilterableColumnDefinitionsSelector", - "returnType": "GridStateColDef[]", - "category": "Columns", - "description": "Get the filterable columns as an array.", - "supportsApiRef": true - }, - { - "name": "gridFilterableColumnLookupSelector", - "returnType": "GridColumnLookup", - "category": "Columns", - "description": "Get the filterable columns as a lookup (an object containing the field for keys and the definition for values).", - "supportsApiRef": true - }, - { - "name": "gridFilteredSortedRowEntriesSelector", - "returnType": "{ id: GridRowId; model: any }[]", - "category": "Filtering", - "description": "Get the id and the model of the rows accessible after the filtering process.\nContains the collapsed children.", - "supportsApiRef": true - }, - { - "name": "gridFilteredSortedRowIdsSelector", - "returnType": "GridRowId[]", - "category": "Filtering", - "description": "Get the id of the rows accessible after the filtering process.\nContains the collapsed children.", - "supportsApiRef": true - }, - { - "name": "gridFocusCellSelector", - "returnType": "GridCellIdentifier | null", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridFocusColumnHeaderSelector", - "returnType": "GridColumnIdentifier | null", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridFocusStateSelector", - "returnType": "GridFocusState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridPageCountSelector", - "returnType": "number", - "category": "Pagination", - "description": "Get the amount of pages needed to display all the rows if the pagination is enabled", - "supportsApiRef": true - }, - { - "name": "gridPageSelector", - "returnType": "number", - "category": "Pagination", - "description": "Get the index of the page to render if the pagination is enabled", - "supportsApiRef": true - }, - { - "name": "gridPageSizeSelector", - "returnType": "number", - "category": "Pagination", - "description": "Get the maximum amount of rows to display on a single page if the pagination is enabled", - "supportsApiRef": true - }, - { - "name": "gridPaginatedVisibleSortedGridRowEntriesSelector", - "returnType": "{ id: GridRowId; model: any }[]", - "category": "Pagination", - "description": "Get the id and the model of each row to include in the current page if the pagination is enabled.", - "supportsApiRef": true - }, - { - "name": "gridPaginatedVisibleSortedGridRowIdsSelector", - "returnType": "GridRowId[]", - "category": "Pagination", - "description": "Get the id of each row to include in the current page if the pagination is enabled.", - "supportsApiRef": true - }, - { - "name": "gridPaginationRowRangeSelector", - "returnType": "{ firstRowIndex: number; lastRowIndex: number } | null", - "category": "Pagination", - "description": "Get the index of the first and the last row to include in the current page if the pagination is enabled.", - "supportsApiRef": true - }, - { - "name": "gridPinnedColumnsSelector", - "returnType": "GridPinnedColumns", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridPreferencePanelStateSelector", - "returnType": "GridPreferencePanelState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridResizingColumnFieldSelector", - "returnType": "string", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowCountSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowGroupingModelSelector", - "returnType": "GridRowGroupingModel", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowGroupingNameSelector", - "returnType": "string", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowGroupingSanitizedModelSelector", - "returnType": "string[]", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowGroupingStateSelector", - "returnType": "GridRowGroupingState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridRowIdsSelector", - "returnType": "GridRowId[]", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowTreeDepthSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowTreeSelector", - "returnType": "GridRowTreeConfig", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowsLookupSelector", - "returnType": "GridRowsLookup", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridRowsMetaSelector", - "returnType": "GridRowsMetaState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridRowsStateSelector", - "returnType": "GridRowsState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridSelectionStateSelector", - "returnType": "GridSelectionModel", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridSortModelSelector", - "returnType": "GridSortModel", - "category": "Sorting", - "description": "Get the current sorting model.", - "supportsApiRef": true - }, - { - "name": "gridSortedRowEntriesSelector", - "returnType": "{ id: GridRowId; model: any }[]", - "category": "Sorting", - "description": "Get the id and the model of the rows after the sorting process.", - "supportsApiRef": true - }, - { - "name": "gridSortedRowIdsSelector", - "returnType": "GridRowId[]", - "category": "Sorting", - "description": "Get the id of the rows after the sorting process.", - "supportsApiRef": true - }, - { - "name": "gridTabIndexCellSelector", - "returnType": "GridCellIdentifier | null", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridTabIndexColumnHeaderSelector", - "returnType": "GridColumnIdentifier | null", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridTabIndexStateSelector", - "returnType": "GridTabIndexState", - "description": "", - "supportsApiRef": false - }, - { - "name": "gridTopLevelRowCountSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "gridVisibleColumnDefinitionsSelector", - "returnType": "GridStateColDef[]", - "category": "Visible Columns", - "description": "Get the visible columns as a lookup (an object containing the field for keys and the definition for values).", - "supportsApiRef": true - }, - { - "name": "gridVisibleColumnFieldsSelector", - "returnType": "string[]", - "category": "Visible Columns", - "description": "Get the field of each visible column.", - "supportsApiRef": true - }, - { - "name": "gridVisibleRowCountSelector", - "returnType": "number", - "category": "Filtering", - "description": "Get the amount of rows accessible after the filtering process.", - "supportsApiRef": true - }, - { - "name": "gridVisibleSortedRowEntriesSelector", - "returnType": "{ id: GridRowId; model: any }[]", - "category": "Filtering", - "description": "Get the id and the model of the rows accessible after the filtering process.\nDoes not contain the collapsed children.", - "supportsApiRef": true - }, - { - "name": "gridVisibleSortedRowIdsSelector", - "returnType": "GridRowId[]", - "category": "Filtering", - "description": "Get the id of the rows accessible after the filtering process.\nDoes not contain the collapsed children.", - "supportsApiRef": true - }, - { - "name": "gridVisibleSortedTopLevelRowEntriesSelector", - "returnType": "{ id: GridRowId; model: any }[]", - "category": "Filtering", - "description": "Get the id and the model of the top level rows accessible after the filtering process.", - "supportsApiRef": true - }, - { - "name": "gridVisibleTopLevelRowCountSelector", - "returnType": "number", - "category": "Filtering", - "description": "Get the amount of top level rows accessible after the filtering process.", - "supportsApiRef": true - }, - { - "name": "selectedGridRowsCountSelector", - "returnType": "number", - "description": "", - "supportsApiRef": true - }, - { - "name": "selectedGridRowsSelector", - "returnType": "Map", - "description": "", - "supportsApiRef": true - }, - { - "name": "selectedIdsLookupSelector", - "returnType": "Record", - "description": "", - "supportsApiRef": true - } -] diff --git a/docs/pages/api-docs/date-pickers/calendar-picker-skeleton.js b/docs/pages/api-docs/date-pickers/calendar-picker-skeleton.js deleted file mode 100644 index 7d6c46248048..000000000000 --- a/docs/pages/api-docs/date-pickers/calendar-picker-skeleton.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './calendar-picker-skeleton.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/calendar-picker-skeleton(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/calendar-picker-skeleton.json b/docs/pages/api-docs/date-pickers/calendar-picker-skeleton.json deleted file mode 100644 index c98d002c8726..000000000000 --- a/docs/pages/api-docs/date-pickers/calendar-picker-skeleton.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "props": { - "classes": { "type": { "name": "object" } }, - "sx": { - "type": { - "name": "union", - "description": "Array<func
| object
| bool>
| func
| object" - } - } - }, - "slots": {}, - "name": "CalendarPickerSkeleton", - "styles": { - "classes": ["root", "week", "daySkeleton"], - "globalClasses": {}, - "name": "MuiCalendarPickerSkeleton" - }, - "spread": true, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx", - "inheritance": null, - "demos": "
    " -} diff --git a/docs/pages/api-docs/date-pickers/calendar-picker.js b/docs/pages/api-docs/date-pickers/calendar-picker.js deleted file mode 100644 index f734a87b026d..000000000000 --- a/docs/pages/api-docs/date-pickers/calendar-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './calendar-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/calendar-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/calendar-picker.json b/docs/pages/api-docs/date-pickers/calendar-picker.json deleted file mode 100644 index 058606917027..000000000000 --- a/docs/pages/api-docs/date-pickers/calendar-picker.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "maxDate": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
    | 'month'
    | 'year'" - }, - "default": "'day'" - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "view": { - "type": { - "name": "enum", - "description": "'day'
    | 'month'
    | 'year'" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
    | 'month'
    | 'year'>" - }, - "default": "['year', 'day']" - } - }, - "slots": {}, - "name": "CalendarPicker", - "styles": { - "classes": ["root", "viewTransitionContainer"], - "globalClasses": {}, - "name": "MuiCalendarPicker" - }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/CalendarPicker/CalendarPicker.tsx", - "inheritance": null, - "demos": "
      " -} diff --git a/docs/pages/api-docs/date-pickers/clock-picker.js b/docs/pages/api-docs/date-pickers/clock-picker.js deleted file mode 100644 index 5edd7f6d20c6..000000000000 --- a/docs/pages/api-docs/date-pickers/clock-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './clock-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/clock-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/clock-picker.json b/docs/pages/api-docs/date-pickers/clock-picker.json deleted file mode 100644 index c40059d809be..000000000000 --- a/docs/pages/api-docs/date-pickers/clock-picker.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "props": { - "date": { "type": { "name": "any" }, "required": true }, - "onChange": { "type": { "name": "func" }, "required": true }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "autoFocus": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, - "components": { "type": { "name": "object" } }, - "componentsProps": { "type": { "name": "object" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getHoursClockNumberText": { - "type": { "name": "func" }, - "default": "(hours: string) => `${hours} hours`" - }, - "getMinutesClockNumberText": { - "type": { "name": "func" }, - "default": "(minutes: string) => `${minutes} minutes`" - }, - "getSecondsClockNumberText": { - "type": { "name": "func" }, - "default": "(seconds: string) => `${seconds} seconds`" - }, - "leftArrowButtonText": { "type": { "name": "string" }, "default": "'open previous view'" }, - "maxTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "onViewChange": { "type": { "name": "func" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'hours'
      | 'minutes'
      | 'seconds'" - }, - "default": "'hours'" - }, - "rightArrowButtonText": { "type": { "name": "string" }, "default": "'open next view'" }, - "shouldDisableTime": { "type": { "name": "func" } }, - "view": { - "type": { - "name": "enum", - "description": "'hours'
      | 'minutes'
      | 'seconds'" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'hours'
      | 'minutes'
      | 'seconds'>" - }, - "default": "['hours', 'minutes']" - } - }, - "slots": {}, - "name": "ClockPicker", - "styles": { "classes": ["root", "arrowSwitcher"], "globalClasses": {}, "name": "MuiClockPicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/ClockPicker/ClockPicker.tsx", - "inheritance": null, - "demos": "
        " -} diff --git a/docs/pages/api-docs/date-pickers/date-picker.js b/docs/pages/api-docs/date-pickers/date-picker.js deleted file mode 100644 index 4ba1e57915fe..000000000000 --- a/docs/pages/api-docs/date-pickers/date-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './date-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/date-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/date-picker.json b/docs/pages/api-docs/date-pickers/date-picker.json deleted file mode 100644 index 8b16fbfae9c7..000000000000 --- a/docs/pages/api-docs/date-pickers/date-picker.json +++ /dev/null @@ -1,108 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "desktopModeMediaQuery": { - "type": { "name": "string" }, - "default": "'@media (pointer: fine)'" - }, - "DialogProps": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
        | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
        | 'month'
        | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
        | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DatePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date'" }, - "TransitionComponent": { "type": { "name": "elementType" } }, - "value": { - "type": { - "name": "union", - "description": "any
        | Date
        | number
        | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
        | 'month'
        | 'year'>" - } - } - }, - "slots": {}, - "name": "DatePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDatePicker" }, - "filename": "/packages/x-date-pickers/src/DatePicker/DatePicker.tsx", - "inheritance": null, - "demos": "
          " -} diff --git a/docs/pages/api-docs/date-pickers/date-range-picker-day.js b/docs/pages/api-docs/date-pickers/date-range-picker-day.js deleted file mode 100644 index e3d56ada41c8..000000000000 --- a/docs/pages/api-docs/date-pickers/date-range-picker-day.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './date-range-picker-day.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/date-range-picker-day(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/date-range-picker-day.json b/docs/pages/api-docs/date-pickers/date-range-picker-day.json deleted file mode 100644 index 4ba9a8805f68..000000000000 --- a/docs/pages/api-docs/date-pickers/date-range-picker-day.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "props": { - "day": { "type": { "name": "any" }, "required": true }, - "isEndOfHighlighting": { "type": { "name": "bool" }, "required": true }, - "isEndOfPreviewing": { "type": { "name": "bool" }, "required": true }, - "isHighlighting": { "type": { "name": "bool" }, "required": true }, - "isPreviewing": { "type": { "name": "bool" }, "required": true }, - "isStartOfHighlighting": { "type": { "name": "bool" }, "required": true }, - "isStartOfPreviewing": { "type": { "name": "bool" }, "required": true }, - "outsideCurrentMonth": { "type": { "name": "bool" }, "required": true }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMargin": { "type": { "name": "bool" } }, - "selected": { "type": { "name": "bool" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "sx": { - "type": { - "name": "union", - "description": "Array<func
          | object
          | bool>
          | func
          | object" - } - }, - "today": { "type": { "name": "bool" } } - }, - "slots": {}, - "name": "DateRangePickerDay", - "styles": { - "classes": [ - "root", - "rangeIntervalDayHighlight", - "rangeIntervalDayHighlightStart", - "rangeIntervalDayHighlightEnd", - "rangeIntervalPreview", - "rangeIntervalDayPreview", - "rangeIntervalDayPreviewStart", - "rangeIntervalDayPreviewEnd", - "day", - "dayOutsideRangeInterval", - "dayInsideRangeInterval", - "notSelectedDate" - ], - "globalClasses": {}, - "name": "MuiDateRangePickerDay" - }, - "spread": false, - "forwardsRefTo": "HTMLButtonElement", - "filename": "/packages/x-date-pickers-pro/src/DateRangePickerDay/DateRangePickerDay.tsx", - "inheritance": null, - "demos": "
            " -} diff --git a/docs/pages/api-docs/date-pickers/date-range-picker.js b/docs/pages/api-docs/date-pickers/date-range-picker.js deleted file mode 100644 index d90e7feec763..000000000000 --- a/docs/pages/api-docs/date-pickers/date-range-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './date-range-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/date-range-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/date-range-picker.json b/docs/pages/api-docs/date-pickers/date-range-picker.json deleted file mode 100644 index 7c4f8d3e3f00..000000000000 --- a/docs/pages/api-docs/date-pickers/date-range-picker.json +++ /dev/null @@ -1,105 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "value": { - "type": { - "name": "arrayOf", - "description": "Array<any
            | Date
            | number
            | string>" - }, - "required": true - }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "calendars": { - "type": { "name": "enum", "description": "1
            | 2
            | 3" }, - "default": "2" - }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "desktopModeMediaQuery": { - "type": { "name": "string" }, - "default": "'@media (pointer: fine)'" - }, - "DialogProps": { "type": { "name": "object" } }, - "disableAutoMonthSwitching": { "type": { "name": "bool" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "endText": { "type": { "name": "node" }, "default": "'End'" }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
            | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" }, "default": "'__/__/____'" }, - "maxDate": { "type": { "name": "any" }, "default": "defaultMaxDate" }, - "minDate": { "type": { "name": "any" }, "default": "defaultMinDate" }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
            | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "startText": { "type": { "name": "node" }, "default": "'Start'" }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" } }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date range'" }, - "TransitionComponent": { "type": { "name": "elementType" } } - }, - "slots": {}, - "name": "DateRangePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDateRangePicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePicker.tsx", - "inheritance": null, - "demos": "
              " -} diff --git a/docs/pages/api-docs/date-pickers/date-time-picker.js b/docs/pages/api-docs/date-pickers/date-time-picker.js deleted file mode 100644 index 2bec19c5b533..000000000000 --- a/docs/pages/api-docs/date-pickers/date-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './date-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/date-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/date-time-picker.json b/docs/pages/api-docs/date-pickers/date-time-picker.json deleted file mode 100644 index 60f393262ad5..000000000000 --- a/docs/pages/api-docs/date-pickers/date-time-picker.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "dateRangeIcon": { "type": { "name": "node" } }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "desktopModeMediaQuery": { - "type": { "name": "string" }, - "default": "'@media (pointer: fine)'" - }, - "DialogProps": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "hideTabs": { "type": { "name": "bool" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
              | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "maxDateTime": { "type": { "name": "any" } }, - "maxTime": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "minDateTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
              | 'hours'
              | 'minutes'
              | 'month'
              | 'seconds'
              | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
              | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "timeIcon": { "type": { "name": "node" } }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DateTimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date & time'" }, - "TransitionComponent": { "type": { "name": "elementType" } }, - "value": { - "type": { - "name": "union", - "description": "any
              | Date
              | number
              | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
              | 'hours'
              | 'minutes'
              | 'month'
              | 'seconds'
              | 'year'>" - } - } - }, - "slots": {}, - "name": "DateTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDateTimePicker" }, - "filename": "/packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx", - "inheritance": null, - "demos": "
                " -} diff --git a/docs/pages/api-docs/date-pickers/desktop-date-picker.js b/docs/pages/api-docs/date-pickers/desktop-date-picker.js deleted file mode 100644 index 8a2d4cc6c671..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-date-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './desktop-date-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/desktop-date-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/desktop-date-picker.json b/docs/pages/api-docs/date-pickers/desktop-date-picker.json deleted file mode 100644 index 9515fe18c749..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-date-picker.json +++ /dev/null @@ -1,99 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
                | 'month'
                | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DatePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date'" }, - "TransitionComponent": { "type": { "name": "elementType" } }, - "value": { - "type": { - "name": "union", - "description": "any
                | Date
                | number
                | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
                | 'month'
                | 'year'>" - } - } - }, - "slots": {}, - "name": "DesktopDatePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDesktopDatePicker" }, - "filename": "/packages/x-date-pickers/src/DesktopDatePicker/DesktopDatePicker.tsx", - "inheritance": null, - "demos": "
                  " -} diff --git a/docs/pages/api-docs/date-pickers/desktop-date-range-picker.js b/docs/pages/api-docs/date-pickers/desktop-date-range-picker.js deleted file mode 100644 index d6f7939c7d84..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-date-range-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './desktop-date-range-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/desktop-date-range-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/desktop-date-range-picker.json b/docs/pages/api-docs/date-pickers/desktop-date-range-picker.json deleted file mode 100644 index ecd865177a05..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-date-range-picker.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "value": { - "type": { - "name": "arrayOf", - "description": "Array<any
                  | Date
                  | number
                  | string>" - }, - "required": true - }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "calendars": { - "type": { "name": "enum", "description": "1
                  | 2
                  | 3" }, - "default": "2" - }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disableAutoMonthSwitching": { "type": { "name": "bool" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "endText": { "type": { "name": "node" }, "default": "'End'" }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                  | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" }, "default": "'__/__/____'" }, - "maxDate": { "type": { "name": "any" }, "default": "defaultMaxDate" }, - "minDate": { "type": { "name": "any" }, "default": "defaultMinDate" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                  | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "startText": { "type": { "name": "node" }, "default": "'Start'" }, - "ToolbarComponent": { "type": { "name": "elementType" } }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date range'" }, - "TransitionComponent": { "type": { "name": "elementType" } } - }, - "slots": {}, - "name": "DesktopDateRangePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDesktopDateRangePicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers-pro/src/DesktopDateRangePicker/DesktopDateRangePicker.tsx", - "inheritance": null, - "demos": "
                    " -} diff --git a/docs/pages/api-docs/date-pickers/desktop-date-time-picker.js b/docs/pages/api-docs/date-pickers/desktop-date-time-picker.js deleted file mode 100644 index fcab83dbeb54..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-date-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './desktop-date-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/desktop-date-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/desktop-date-time-picker.json b/docs/pages/api-docs/date-pickers/desktop-date-time-picker.json deleted file mode 100644 index 37ea048a4f93..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-date-time-picker.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "dateRangeIcon": { "type": { "name": "node" } }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "hideTabs": { "type": { "name": "bool" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                    | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "maxDateTime": { "type": { "name": "any" } }, - "maxTime": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "minDateTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
                    | 'hours'
                    | 'minutes'
                    | 'month'
                    | 'seconds'
                    | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                    | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "timeIcon": { "type": { "name": "node" } }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DateTimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date & time'" }, - "TransitionComponent": { "type": { "name": "elementType" } }, - "value": { - "type": { - "name": "union", - "description": "any
                    | Date
                    | number
                    | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
                    | 'hours'
                    | 'minutes'
                    | 'month'
                    | 'seconds'
                    | 'year'>" - } - } - }, - "slots": {}, - "name": "DesktopDateTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDesktopDateTimePicker" }, - "filename": "/packages/x-date-pickers/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx", - "inheritance": null, - "demos": "
                      " -} diff --git a/docs/pages/api-docs/date-pickers/desktop-time-picker.js b/docs/pages/api-docs/date-pickers/desktop-time-picker.js deleted file mode 100644 index d6c432d6038a..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './desktop-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/desktop-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/desktop-time-picker.json b/docs/pages/api-docs/date-pickers/desktop-time-picker.json deleted file mode 100644 index eb384cf3339a..000000000000 --- a/docs/pages/api-docs/date-pickers/desktop-time-picker.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                      | { current?: object }" } - }, - "mask": { "type": { "name": "string" } }, - "maxTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'hours'
                      | 'minutes'
                      | 'seconds'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                      | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "rifmFormatter": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "showToolbar": { "type": { "name": "bool" } }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "TimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select time'" }, - "TransitionComponent": { "type": { "name": "elementType" } }, - "value": { - "type": { - "name": "union", - "description": "any
                      | Date
                      | number
                      | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'hours'
                      | 'minutes'
                      | 'seconds'>" - } - } - }, - "slots": {}, - "name": "DesktopTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiDesktopTimePicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/DesktopTimePicker/DesktopTimePicker.tsx", - "inheritance": null, - "demos": "
                        " -} diff --git a/docs/pages/api-docs/date-pickers/localization-provider.js b/docs/pages/api-docs/date-pickers/localization-provider.js deleted file mode 100644 index 4673cbecd490..000000000000 --- a/docs/pages/api-docs/date-pickers/localization-provider.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './localization-provider.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/localization-provider(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/localization-provider.json b/docs/pages/api-docs/date-pickers/localization-provider.json deleted file mode 100644 index 95cefac3958a..000000000000 --- a/docs/pages/api-docs/date-pickers/localization-provider.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "props": { - "dateAdapter": { "type": { "name": "func" }, "required": true }, - "dateFormats": { - "type": { - "name": "shape", - "description": "{ dayOfMonth?: string, fullDate?: string, fullDateTime?: string, fullDateTime12h?: string, fullDateTime24h?: string, fullDateWithWeekday?: string, fullTime?: string, fullTime12h?: string, fullTime24h?: string, hours12h?: string, hours24h?: string, keyboardDate?: string, keyboardDateTime?: string, keyboardDateTime12h?: string, keyboardDateTime24h?: string, minutes?: string, month?: string, monthAndDate?: string, monthAndYear?: string, monthShort?: string, normalDate?: string, normalDateWithWeekday?: string, seconds?: string, shortDate?: string, weekday?: string, weekdayShort?: string, year?: string }" - } - }, - "dateLibInstance": { "type": { "name": "any" } }, - "locale": { "type": { "name": "union", "description": "object
                        | string" } } - }, - "slots": {}, - "name": "LocalizationProvider", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiLocalizationProvider" }, - "filename": "/packages/x-date-pickers/src/LocalizationProvider/LocalizationProvider.tsx", - "demos": "
                          " -} diff --git a/docs/pages/api-docs/date-pickers/mobile-date-picker.js b/docs/pages/api-docs/date-pickers/mobile-date-picker.js deleted file mode 100644 index 7ca47dcc45e4..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-date-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './mobile-date-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/mobile-date-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/mobile-date-picker.json b/docs/pages/api-docs/date-pickers/mobile-date-picker.json deleted file mode 100644 index 526528b2141a..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-date-picker.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "DialogProps": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                          | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
                          | 'month'
                          | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                          | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DatePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date'" }, - "value": { - "type": { - "name": "union", - "description": "any
                          | Date
                          | number
                          | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
                          | 'month'
                          | 'year'>" - } - } - }, - "slots": {}, - "name": "MobileDatePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiMobileDatePicker" }, - "filename": "/packages/x-date-pickers/src/MobileDatePicker/MobileDatePicker.tsx", - "inheritance": null, - "demos": "
                            " -} diff --git a/docs/pages/api-docs/date-pickers/mobile-date-range-picker.js b/docs/pages/api-docs/date-pickers/mobile-date-range-picker.js deleted file mode 100644 index 9cb9899048c6..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-date-range-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './mobile-date-range-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/mobile-date-range-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/mobile-date-range-picker.json b/docs/pages/api-docs/date-pickers/mobile-date-range-picker.json deleted file mode 100644 index b817e1780721..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-date-range-picker.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "value": { - "type": { - "name": "arrayOf", - "description": "Array<any
                            | Date
                            | number
                            | string>" - }, - "required": true - }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "calendars": { - "type": { "name": "enum", "description": "1
                            | 2
                            | 3" }, - "default": "2" - }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "DialogProps": { "type": { "name": "object" } }, - "disableAutoMonthSwitching": { "type": { "name": "bool" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "endText": { "type": { "name": "node" }, "default": "'End'" }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                            | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" }, "default": "'__/__/____'" }, - "maxDate": { "type": { "name": "any" }, "default": "defaultMaxDate" }, - "minDate": { "type": { "name": "any" }, "default": "defaultMinDate" }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                            | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "startText": { "type": { "name": "node" }, "default": "'Start'" }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" } }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date range'" } - }, - "slots": {}, - "name": "MobileDateRangePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiMobileDateRangePicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers-pro/src/MobileDateRangePicker/MobileDateRangePicker.tsx", - "inheritance": null, - "demos": "
                              " -} diff --git a/docs/pages/api-docs/date-pickers/mobile-date-time-picker.js b/docs/pages/api-docs/date-pickers/mobile-date-time-picker.js deleted file mode 100644 index 95cf591947c2..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-date-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './mobile-date-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/mobile-date-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/mobile-date-time-picker.json b/docs/pages/api-docs/date-pickers/mobile-date-time-picker.json deleted file mode 100644 index 381531803194..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-date-time-picker.json +++ /dev/null @@ -1,117 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "dateRangeIcon": { "type": { "name": "node" } }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "DialogProps": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "hideTabs": { "type": { "name": "bool" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                              | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "maxDateTime": { "type": { "name": "any" } }, - "maxTime": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "minDateTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
                              | 'hours'
                              | 'minutes'
                              | 'month'
                              | 'seconds'
                              | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                              | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "timeIcon": { "type": { "name": "node" } }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DateTimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date & time'" }, - "value": { - "type": { - "name": "union", - "description": "any
                              | Date
                              | number
                              | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
                              | 'hours'
                              | 'minutes'
                              | 'month'
                              | 'seconds'
                              | 'year'>" - } - } - }, - "slots": {}, - "name": "MobileDateTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiMobileDateTimePicker" }, - "filename": "/packages/x-date-pickers/src/MobileDateTimePicker/MobileDateTimePicker.tsx", - "inheritance": null, - "demos": "
                                " -} diff --git a/docs/pages/api-docs/date-pickers/mobile-time-picker.js b/docs/pages/api-docs/date-pickers/mobile-time-picker.js deleted file mode 100644 index 855e63e8f9ca..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './mobile-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/mobile-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/mobile-time-picker.json b/docs/pages/api-docs/date-pickers/mobile-time-picker.json deleted file mode 100644 index ec8ac034bc7c..000000000000 --- a/docs/pages/api-docs/date-pickers/mobile-time-picker.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" } }, - "DialogProps": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                                | { current?: object }" } - }, - "mask": { "type": { "name": "string" } }, - "maxTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'hours'
                                | 'minutes'
                                | 'seconds'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                                | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "rifmFormatter": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "TimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select time'" }, - "value": { - "type": { - "name": "union", - "description": "any
                                | Date
                                | number
                                | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'hours'
                                | 'minutes'
                                | 'seconds'>" - } - } - }, - "slots": {}, - "name": "MobileTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiMobileTimePicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/MobileTimePicker/MobileTimePicker.tsx", - "inheritance": null, - "demos": "
                                  " -} diff --git a/docs/pages/api-docs/date-pickers/month-picker.js b/docs/pages/api-docs/date-pickers/month-picker.js deleted file mode 100644 index 78b67661c6bb..000000000000 --- a/docs/pages/api-docs/date-pickers/month-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './month-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/month-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/month-picker.json b/docs/pages/api-docs/date-pickers/month-picker.json deleted file mode 100644 index 1597ef6c6979..000000000000 --- a/docs/pages/api-docs/date-pickers/month-picker.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "props": { - "date": { "type": { "name": "any" }, "required": true }, - "maxDate": { "type": { "name": "any" }, "required": true }, - "minDate": { "type": { "name": "any" }, "required": true }, - "onChange": { "type": { "name": "func" }, "required": true }, - "classes": { "type": { "name": "object" } }, - "className": { "type": { "name": "string" } }, - "disabled": { "type": { "name": "bool" } }, - "disableFuture": { "type": { "name": "bool" } }, - "disablePast": { "type": { "name": "bool" } }, - "readOnly": { "type": { "name": "bool" } }, - "sx": { - "type": { - "name": "union", - "description": "Array<func
                                  | object
                                  | bool>
                                  | func
                                  | object" - } - } - }, - "slots": {}, - "name": "MonthPicker", - "styles": { "classes": ["root"], "globalClasses": {}, "name": "MuiMonthPicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/MonthPicker/MonthPicker.tsx", - "inheritance": null, - "demos": "
                                    " -} diff --git a/docs/pages/api-docs/date-pickers/pickers-day.js b/docs/pages/api-docs/date-pickers/pickers-day.js deleted file mode 100644 index 4cd3cbbdc88c..000000000000 --- a/docs/pages/api-docs/date-pickers/pickers-day.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './pickers-day.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/pickers-day(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/pickers-day.json b/docs/pages/api-docs/date-pickers/pickers-day.json deleted file mode 100644 index 94b74a6ebfbc..000000000000 --- a/docs/pages/api-docs/date-pickers/pickers-day.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "props": { - "day": { "type": { "name": "any" }, "required": true }, - "outsideCurrentMonth": { "type": { "name": "bool" }, "required": true }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "classes": { "type": { "name": "object" } }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMargin": { "type": { "name": "bool" } }, - "selected": { "type": { "name": "bool" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "sx": { - "type": { - "name": "union", - "description": "Array<func
                                    | object
                                    | bool>
                                    | func
                                    | object" - } - }, - "today": { "type": { "name": "bool" } } - }, - "slots": {}, - "name": "PickersDay", - "styles": { - "classes": [ - "root", - "dayWithMargin", - "dayOutsideMonth", - "hiddenDaySpacingFiller", - "today", - "selected", - "disabled" - ], - "globalClasses": { "selected": "Mui-selected", "disabled": "Mui-disabled" }, - "name": "MuiPickersDay" - }, - "spread": true, - "forwardsRefTo": "HTMLButtonElement", - "filename": "/packages/x-date-pickers/src/PickersDay/PickersDay.tsx", - "inheritance": null, - "demos": "
                                      " -} diff --git a/docs/pages/api-docs/date-pickers/static-date-picker.js b/docs/pages/api-docs/date-pickers/static-date-picker.js deleted file mode 100644 index 5fd9fd093022..000000000000 --- a/docs/pages/api-docs/date-pickers/static-date-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './static-date-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/static-date-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/static-date-picker.json b/docs/pages/api-docs/date-pickers/static-date-picker.json deleted file mode 100644 index 486d7e3e9d52..000000000000 --- a/docs/pages/api-docs/date-pickers/static-date-picker.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "displayStaticWrapperAs": { - "type": { "name": "enum", "description": "'desktop'
                                      | 'mobile'" }, - "default": "'mobile'" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                                      | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
                                      | 'month'
                                      | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                                      | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DatePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date'" }, - "value": { - "type": { - "name": "union", - "description": "any
                                      | Date
                                      | number
                                      | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
                                      | 'month'
                                      | 'year'>" - } - } - }, - "slots": {}, - "name": "StaticDatePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiStaticDatePicker" }, - "filename": "/packages/x-date-pickers/src/StaticDatePicker/StaticDatePicker.tsx", - "inheritance": null, - "demos": "
                                        " -} diff --git a/docs/pages/api-docs/date-pickers/static-date-range-picker.js b/docs/pages/api-docs/date-pickers/static-date-range-picker.js deleted file mode 100644 index fbd8f6d8f04f..000000000000 --- a/docs/pages/api-docs/date-pickers/static-date-range-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './static-date-range-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/static-date-range-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/static-date-range-picker.json b/docs/pages/api-docs/date-pickers/static-date-range-picker.json deleted file mode 100644 index 917c4e18a922..000000000000 --- a/docs/pages/api-docs/date-pickers/static-date-range-picker.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "value": { - "type": { - "name": "arrayOf", - "description": "Array<any
                                        | Date
                                        | number
                                        | string>" - }, - "required": true - }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "calendars": { - "type": { "name": "enum", "description": "1
                                        | 2
                                        | 3" }, - "default": "2" - }, - "className": { "type": { "name": "string" } }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disableAutoMonthSwitching": { "type": { "name": "bool" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "displayStaticWrapperAs": { - "type": { "name": "enum", "description": "'desktop'
                                        | 'mobile'" }, - "default": "'mobile'" - }, - "endText": { "type": { "name": "node" }, "default": "'End'" }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                                        | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" }, "default": "'__/__/____'" }, - "maxDate": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                                        | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "startText": { "type": { "name": "node" }, "default": "'Start'" }, - "ToolbarComponent": { "type": { "name": "elementType" } }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date range'" } - }, - "slots": {}, - "name": "StaticDateRangePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiStaticDateRangePicker" }, - "spread": false, - "forwardsRefTo": "undefined", - "filename": "/packages/x-date-pickers-pro/src/StaticDateRangePicker/StaticDateRangePicker.tsx", - "inheritance": null, - "demos": "
                                          " -} diff --git a/docs/pages/api-docs/date-pickers/static-date-time-picker.js b/docs/pages/api-docs/date-pickers/static-date-time-picker.js deleted file mode 100644 index a7df31d9a2b1..000000000000 --- a/docs/pages/api-docs/date-pickers/static-date-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './static-date-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/static-date-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/static-date-time-picker.json b/docs/pages/api-docs/date-pickers/static-date-time-picker.json deleted file mode 100644 index 5788cb733cb1..000000000000 --- a/docs/pages/api-docs/date-pickers/static-date-time-picker.json +++ /dev/null @@ -1,114 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "allowSameDateSelection": { "type": { "name": "bool" } }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "components": { "type": { "name": "object" }, "default": "{}" }, - "componentsProps": { "type": { "name": "object" }, "default": "{}" }, - "dateRangeIcon": { "type": { "name": "node" } }, - "defaultCalendarMonth": { "type": { "name": "any" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableHighlightToday": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "displayStaticWrapperAs": { - "type": { "name": "enum", "description": "'desktop'
                                          | 'mobile'" }, - "default": "'mobile'" - }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "getViewSwitchingButtonText": { "type": { "name": "func" } }, - "hideTabs": { "type": { "name": "bool" } }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                                          | { current?: object }" } - }, - "leftArrowButtonText": { "type": { "name": "string" } }, - "loading": { "type": { "name": "bool" } }, - "mask": { "type": { "name": "string" } }, - "maxDate": { "type": { "name": "any" } }, - "maxDateTime": { "type": { "name": "any" } }, - "maxTime": { "type": { "name": "any" } }, - "minDate": { "type": { "name": "any" } }, - "minDateTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onMonthChange": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "onYearChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'day'
                                          | 'hours'
                                          | 'minutes'
                                          | 'month'
                                          | 'seconds'
                                          | 'year'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                                          | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "reduceAnimations": { - "type": { "name": "bool" }, - "default": "typeof navigator !== 'undefined' && /(android)/i.test(navigator.userAgent)" - }, - "renderDay": { "type": { "name": "func" } }, - "renderLoading": { - "type": { "name": "func" }, - "default": "() => ..." - }, - "rifmFormatter": { "type": { "name": "func" } }, - "rightArrowButtonText": { "type": { "name": "string" } }, - "shouldDisableDate": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } }, - "showDaysOutsideCurrentMonth": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "timeIcon": { "type": { "name": "node" } }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "DateTimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select date & time'" }, - "value": { - "type": { - "name": "union", - "description": "any
                                          | Date
                                          | number
                                          | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'day'
                                          | 'hours'
                                          | 'minutes'
                                          | 'month'
                                          | 'seconds'
                                          | 'year'>" - } - } - }, - "slots": {}, - "name": "StaticDateTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiStaticDateTimePicker" }, - "filename": "/packages/x-date-pickers/src/StaticDateTimePicker/StaticDateTimePicker.tsx", - "inheritance": null, - "demos": "
                                            " -} diff --git a/docs/pages/api-docs/date-pickers/static-time-picker.js b/docs/pages/api-docs/date-pickers/static-time-picker.js deleted file mode 100644 index b7a4782a885c..000000000000 --- a/docs/pages/api-docs/date-pickers/static-time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './static-time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/static-time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/static-time-picker.json b/docs/pages/api-docs/date-pickers/static-time-picker.json deleted file mode 100644 index d1bf3afae0f7..000000000000 --- a/docs/pages/api-docs/date-pickers/static-time-picker.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "className": { "type": { "name": "string" } }, - "components": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "displayStaticWrapperAs": { - "type": { "name": "enum", "description": "'desktop'
                                            | 'mobile'" }, - "default": "'mobile'" - }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                                            | { current?: object }" } - }, - "mask": { "type": { "name": "string" } }, - "maxTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'hours'
                                            | 'minutes'
                                            | 'seconds'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                                            | 'portrait'" } - }, - "readOnly": { "type": { "name": "bool" } }, - "rifmFormatter": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "showToolbar": { "type": { "name": "bool" } }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "TimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select time'" }, - "value": { - "type": { - "name": "union", - "description": "any
                                            | Date
                                            | number
                                            | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'hours'
                                            | 'minutes'
                                            | 'seconds'>" - } - } - }, - "slots": {}, - "name": "StaticTimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiStaticTimePicker" }, - "spread": false, - "forwardsRefTo": "undefined", - "filename": "/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx", - "inheritance": null, - "demos": "
                                              " -} diff --git a/docs/pages/api-docs/date-pickers/time-picker.js b/docs/pages/api-docs/date-pickers/time-picker.js deleted file mode 100644 index 4cd2f41980c7..000000000000 --- a/docs/pages/api-docs/date-pickers/time-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './time-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/time-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/time-picker.json b/docs/pages/api-docs/date-pickers/time-picker.json deleted file mode 100644 index a85f0c6b9bc2..000000000000 --- a/docs/pages/api-docs/date-pickers/time-picker.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "props": { - "onChange": { "type": { "name": "func" }, "required": true }, - "renderInput": { "type": { "name": "func" }, "required": true }, - "acceptRegex": { - "type": { "name": "instanceOf", "description": "RegExp" }, - "default": "/\\dap/gi" - }, - "ampm": { "type": { "name": "bool" } }, - "ampmInClock": { "type": { "name": "bool" } }, - "cancelText": { "type": { "name": "node" }, "default": "'Cancel'" }, - "className": { "type": { "name": "string" } }, - "clearable": { "type": { "name": "bool" } }, - "clearText": { "type": { "name": "node" }, "default": "'Clear'" }, - "components": { "type": { "name": "object" } }, - "desktopModeMediaQuery": { - "type": { "name": "string" }, - "default": "'@media (pointer: fine)'" - }, - "DialogProps": { "type": { "name": "object" } }, - "disableCloseOnSelect": { - "type": { "name": "bool" }, - "default": "`true` for Desktop, `false` for Mobile (based on the chosen wrapper and `desktopModeMediaQuery` prop)." - }, - "disabled": { "type": { "name": "bool" } }, - "disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } }, - "disableMaskedInput": { "type": { "name": "bool" } }, - "disableOpenPicker": { "type": { "name": "bool" } }, - "getClockLabelText": { - "type": { "name": "func" }, - "default": "(\n view: ClockView,\n time: TDate | null,\n adapter: MuiPickersAdapter,\n) =>\n `Select ${view}. ${\n time === null ? 'No time selected' : `Selected time is ${adapter.format(time, 'fullTime')}`\n }`" - }, - "getOpenDialogAriaText": { - "type": { "name": "func" }, - "default": "(value, utils) => `Choose date, selected date is ${utils.format(utils.date(value), 'fullDate')}`" - }, - "InputAdornmentProps": { "type": { "name": "object" } }, - "inputFormat": { "type": { "name": "string" } }, - "inputRef": { - "type": { "name": "union", "description": "func
                                              | { current?: object }" } - }, - "mask": { "type": { "name": "string" } }, - "maxTime": { "type": { "name": "any" } }, - "minTime": { "type": { "name": "any" } }, - "minutesStep": { "type": { "name": "number" }, "default": "1" }, - "okText": { "type": { "name": "node" }, "default": "'OK'" }, - "onAccept": { "type": { "name": "func" } }, - "onClose": { "type": { "name": "func" } }, - "onError": { "type": { "name": "func" } }, - "onOpen": { "type": { "name": "func" } }, - "onViewChange": { "type": { "name": "func" } }, - "open": { "type": { "name": "bool" } }, - "OpenPickerButtonProps": { "type": { "name": "object" } }, - "openTo": { - "type": { - "name": "enum", - "description": "'hours'
                                              | 'minutes'
                                              | 'seconds'" - } - }, - "orientation": { - "type": { "name": "enum", "description": "'landscape'
                                              | 'portrait'" } - }, - "PaperProps": { "type": { "name": "object" } }, - "PopperProps": { "type": { "name": "object" } }, - "readOnly": { "type": { "name": "bool" } }, - "rifmFormatter": { "type": { "name": "func" } }, - "shouldDisableTime": { "type": { "name": "func" } }, - "showTodayButton": { "type": { "name": "bool" } }, - "showToolbar": { "type": { "name": "bool" } }, - "todayText": { "type": { "name": "node" }, "default": "'Today'" }, - "ToolbarComponent": { "type": { "name": "elementType" }, "default": "TimePickerToolbar" }, - "toolbarFormat": { "type": { "name": "string" } }, - "toolbarPlaceholder": { "type": { "name": "node" }, "default": "'โ€“'" }, - "toolbarTitle": { "type": { "name": "node" }, "default": "'Select time'" }, - "TransitionComponent": { "type": { "name": "elementType" } }, - "value": { - "type": { - "name": "union", - "description": "any
                                              | Date
                                              | number
                                              | string" - } - }, - "views": { - "type": { - "name": "arrayOf", - "description": "Array<'hours'
                                              | 'minutes'
                                              | 'seconds'>" - } - } - }, - "slots": {}, - "name": "TimePicker", - "styles": { "classes": [], "globalClasses": {}, "name": "MuiTimePicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/TimePicker/TimePicker.tsx", - "inheritance": null, - "demos": "
                                                " -} diff --git a/docs/pages/api-docs/date-pickers/year-picker.js b/docs/pages/api-docs/date-pickers/year-picker.js deleted file mode 100644 index c13c54c6adfb..000000000000 --- a/docs/pages/api-docs/date-pickers/year-picker.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as React from 'react'; -import ApiPage from 'docsx/src/modules/components/ApiPage'; -import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations'; -import jsonPageContent from './year-picker.json'; - -export default function Page(props) { - const { descriptions, pageContent } = props; - return ; -} - -Page.getInitialProps = () => { - const req = require.context( - 'docsx/translations/api-docs/date-pickers', - false, - /\/year-picker(-[a-z]{2})?\.json$/, - ); - const descriptions = mapApiPageTranslations(req); - - return { - descriptions, - pageContent: jsonPageContent, - }; -}; diff --git a/docs/pages/api-docs/date-pickers/year-picker.json b/docs/pages/api-docs/date-pickers/year-picker.json deleted file mode 100644 index d3a76d7200db..000000000000 --- a/docs/pages/api-docs/date-pickers/year-picker.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "props": { - "onYearChange": { "type": { "name": "func" } }, - "shouldDisableYear": { "type": { "name": "func" } } - }, - "slots": {}, - "name": "YearPicker", - "styles": { "classes": ["root"], "globalClasses": {}, "name": "MuiYearPicker" }, - "spread": false, - "forwardsRefTo": "HTMLDivElement", - "filename": "/packages/x-date-pickers/src/YearPicker/YearPicker.tsx", - "inheritance": null, - "demos": "
                                                  " -} diff --git a/docs/pages/components/data-grid/accessibility.js b/docs/pages/components/data-grid/accessibility.js deleted file mode 100644 index 3c618c28a330..000000000000 --- a/docs/pages/components/data-grid/accessibility.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/accessibility/accessibility.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/columns.js b/docs/pages/components/data-grid/columns.js deleted file mode 100644 index 817105998fdb..000000000000 --- a/docs/pages/components/data-grid/columns.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/columns/columns.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/components.js b/docs/pages/components/data-grid/components.js deleted file mode 100644 index e239bc0e9489..000000000000 --- a/docs/pages/components/data-grid/components.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/components/components.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/demo.js b/docs/pages/components/data-grid/demo.js deleted file mode 100644 index 5e02ad8f909c..000000000000 --- a/docs/pages/components/data-grid/demo.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/demo/demo.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/editing.js b/docs/pages/components/data-grid/editing.js deleted file mode 100644 index 780dc9ae9576..000000000000 --- a/docs/pages/components/data-grid/editing.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/editing/editing.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/events.js b/docs/pages/components/data-grid/events.js deleted file mode 100644 index e9af2a4d90d8..000000000000 --- a/docs/pages/components/data-grid/events.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/events/events.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/export.js b/docs/pages/components/data-grid/export.js deleted file mode 100644 index 1f6c8ebb78da..000000000000 --- a/docs/pages/components/data-grid/export.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/export/export.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/filtering.js b/docs/pages/components/data-grid/filtering.js deleted file mode 100644 index 8606f8c28bd8..000000000000 --- a/docs/pages/components/data-grid/filtering.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/filtering/filtering.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/getting-started.js b/docs/pages/components/data-grid/getting-started.js deleted file mode 100644 index cbd3dca5547b..000000000000 --- a/docs/pages/components/data-grid/getting-started.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/getting-started/getting-started.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/group-pivot.js b/docs/pages/components/data-grid/group-pivot.js deleted file mode 100644 index 8f6931a8bb07..000000000000 --- a/docs/pages/components/data-grid/group-pivot.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/group-pivot/group-pivot.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/index.js b/docs/pages/components/data-grid/index.js deleted file mode 100644 index dda709580584..000000000000 --- a/docs/pages/components/data-grid/index.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/overview/overview.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/layout.js b/docs/pages/components/data-grid/layout.js deleted file mode 100644 index 05f7c4f724f0..000000000000 --- a/docs/pages/components/data-grid/layout.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/layout/layout.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/localization.js b/docs/pages/components/data-grid/localization.js deleted file mode 100644 index 591ede9e1aca..000000000000 --- a/docs/pages/components/data-grid/localization.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/localization/localization.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/migration-v4.js b/docs/pages/components/data-grid/migration-v4.js deleted file mode 100644 index a1aca4b3cc0c..000000000000 --- a/docs/pages/components/data-grid/migration-v4.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/getting-started/migration-v4.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/pagination.js b/docs/pages/components/data-grid/pagination.js deleted file mode 100644 index 6d5d9cdd8cbe..000000000000 --- a/docs/pages/components/data-grid/pagination.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/pagination/pagination.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/rows.js b/docs/pages/components/data-grid/rows.js deleted file mode 100644 index 9c68738d0fd7..000000000000 --- a/docs/pages/components/data-grid/rows.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/rows/rows.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/scrolling.js b/docs/pages/components/data-grid/scrolling.js deleted file mode 100644 index 8d05ab04bbc5..000000000000 --- a/docs/pages/components/data-grid/scrolling.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/scrolling/scrolling.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/selection.js b/docs/pages/components/data-grid/selection.js deleted file mode 100644 index 2a6f6ceb5e7c..000000000000 --- a/docs/pages/components/data-grid/selection.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/selection/selection.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/sorting.js b/docs/pages/components/data-grid/sorting.js deleted file mode 100644 index 127afa523041..000000000000 --- a/docs/pages/components/data-grid/sorting.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/sorting/sorting.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/state.js b/docs/pages/components/data-grid/state.js deleted file mode 100644 index 959a52e952cb..000000000000 --- a/docs/pages/components/data-grid/state.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/state/state.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/style.js b/docs/pages/components/data-grid/style.js deleted file mode 100644 index d4ee56142f0a..000000000000 --- a/docs/pages/components/data-grid/style.js +++ /dev/null @@ -1,7 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { demos, docs, demoComponents } from 'docsx/data/data-grid/style/style.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/data-grid/virtualization.js b/docs/pages/components/data-grid/virtualization.js deleted file mode 100644 index a50d59ce7da9..000000000000 --- a/docs/pages/components/data-grid/virtualization.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/data-grid/virtualization/virtualization.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/date-pickers/date-picker.js b/docs/pages/components/date-pickers/date-picker.js deleted file mode 100644 index b82a6db8e5f9..000000000000 --- a/docs/pages/components/date-pickers/date-picker.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/date-pickers/date-picker/date-picker.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/date-pickers/date-range-picker.js b/docs/pages/components/date-pickers/date-range-picker.js deleted file mode 100644 index 0215ad87494c..000000000000 --- a/docs/pages/components/date-pickers/date-range-picker.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/date-pickers/date-range-picker/date-range-picker.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/date-pickers/date-time-picker.js b/docs/pages/components/date-pickers/date-time-picker.js deleted file mode 100644 index fd20bdc259d1..000000000000 --- a/docs/pages/components/date-pickers/date-time-picker.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/date-pickers/date-time-picker/date-time-picker.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/date-pickers/getting-started.js b/docs/pages/components/date-pickers/getting-started.js deleted file mode 100644 index cd8afdf90d6a..000000000000 --- a/docs/pages/components/date-pickers/getting-started.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/date-pickers/getting-started/getting-started.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/components/date-pickers/time-picker.js b/docs/pages/components/date-pickers/time-picker.js deleted file mode 100644 index 08b5f23acc5f..000000000000 --- a/docs/pages/components/date-pickers/time-picker.js +++ /dev/null @@ -1,11 +0,0 @@ -import * as React from 'react'; -import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs'; -import { - demos, - docs, - demoComponents, -} from 'docsx/data/date-pickers/time-picker/time-picker.md?@mui/markdown'; - -export default function Page() { - return ; -} diff --git a/docs/pages/x/api/data-grid/data-grid-pro.json b/docs/pages/x/api/data-grid/data-grid-pro.json index c377d52973e1..b7941c55380f 100644 --- a/docs/pages/x/api/data-grid/data-grid-pro.json +++ b/docs/pages/x/api/data-grid/data-grid-pro.json @@ -135,7 +135,7 @@ "onEditCellPropsChange": { "type": { "name": "func" }, "deprecated": true, - "deprecationInfo": "use preProcessEditCellProps from the GridColDef" + "deprecationInfo": "use preProcessEditCellProps from the GridColDef" }, "onEditRowsModelChange": { "type": { "name": "func" } }, "onError": { "type": { "name": "func" } }, diff --git a/docs/pages/x/api/data-grid/data-grid.json b/docs/pages/x/api/data-grid/data-grid.json index f77e5a0b57d1..5770d14e6027 100644 --- a/docs/pages/x/api/data-grid/data-grid.json +++ b/docs/pages/x/api/data-grid/data-grid.json @@ -103,7 +103,7 @@ "onEditCellPropsChange": { "type": { "name": "func" }, "deprecated": true, - "deprecationInfo": "use preProcessEditCellProps from the GridColDef" + "deprecationInfo": "use preProcessEditCellProps from the GridColDef" }, "onEditRowsModelChange": { "type": { "name": "func" } }, "onError": { "type": { "name": "func" } }, diff --git a/docs/pages/x/api/data-grid/grid-api.md b/docs/pages/x/api/data-grid/grid-api.md index 0726d5e251a5..6aaf4a74529c 100644 --- a/docs/pages/x/api/data-grid/grid-api.md +++ b/docs/pages/x/api/data-grid/grid-api.md @@ -16,18 +16,18 @@ import { GridApi } from '@mui/x-data-grid-pro'; | applySorting | () => void | Applies the current sort model to the rows. | | commitCellChange | (params: GridCommitCellChangeParams, event?: MuiBaseEvent) => boolean \| Promise<boolean> | Updates the field corresponding to the given id with the value stored in the edit row model. | | commitRowChange | (id: GridRowId, event?: MuiBaseEvent) => boolean \| Promise<boolean> | Updates the row corresponding to the given id with the values stored in the edit row model. | -| deleteFilterItem | (item: GridFilterItem) => void | Deletes a [GridFilterItem](/api/data-grid/grid-filter-item/). | +| deleteFilterItem | (item: GridFilterItem) => void | Deletes a [GridFilterItem](/x/api/data-grid/grid-filter-item/). | | exportDataAsCsv | (options?: GridCsvExportOptions) => void | Downloads and exports a CSV of the grid's data. | | exportDataAsPrint | (options?: GridPrintExportOptions) => void | Print the grid's data. | | exportState | () => InitialState | Generates a serializable object containing the exportable parts of the DataGrid state.
                                                  These values can then be passed to the `initialState` prop or injected using the `restoreState` method. | | forceUpdate | () => void | Forces the grid to rerender. It's often used after a state update. | -| getAllColumns | () => GridStateColDef[] | Returns an array of [GridColDef](/api/data-grid/grid-col-def/) containing all the column definitions. | +| getAllColumns | () => GridStateColDef[] | Returns an array of [GridColDef](/x/api/data-grid/grid-col-def/) containing all the column definitions. | | getAllRowIds | () => GridRowId[] | Gets the list of row ids. | | getCellElement | (id: GridRowId, field: string) => HTMLDivElement \| null | Gets the underlying DOM element for a cell at the given `id` and `field`. | | getCellMode | (id: GridRowId, field: string) => GridCellMode | Gets the mode of a cell. | -| getCellParams | <V = any, R extends GridValidRowModel = any, F = V>(id: GridRowId, field: string) => GridCellParams<R, V, F> | Gets the [GridCellParams](/api/data-grid/grid-cell-params/) object that is passed as argument in events. | +| getCellParams | <V = any, R extends GridValidRowModel = any, F = V>(id: GridRowId, field: string) => GridCellParams<R, V, F> | Gets the [GridCellParams](/x/api/data-grid/grid-cell-params/) object that is passed as argument in events. | | getCellValue | <V extends any = any>(id: GridRowId, field: string) => V | Gets the value of a cell at the given `id` and `field`. | -| getColumn | (field: string) => GridStateColDef | Returns the [GridColDef](/api/data-grid/grid-col-def/) for the given `field`. | +| getColumn | (field: string) => GridStateColDef | Returns the [GridColDef](/x/api/data-grid/grid-col-def/) for the given `field`. | | getColumnHeaderElement | (field: string) => HTMLDivElement \| null | Gets the underlying DOM element for the column header with the given `field`. | | getColumnHeaderParams | (field: string) => GridColumnHeaderParams | Gets the GridColumnHeaderParams object that is passed as argument in events. | | getColumnIndex | (field: string, useVisibleColumns?: boolean) => number | Returns the index position of a column. By default, only the visible columns are considered.
                                                  Pass `false` to `useVisibleColumns` to consider all columns. | @@ -47,7 +47,7 @@ import { GridApi } from '@mui/x-data-grid-pro'; | getRowMode | (id: GridRowId) => GridRowMode | Gets the mode of a row. | | getRowModels | () => Map<GridRowId, GridRowModel> | Gets the full set of rows as Map<GridRowId, GridRowModel>. | | getRowNode | (id: GridRowId) => GridRowTreeNodeConfig \| null | Gets the row node from the internal tree structure. | -| getRowParams | (id: GridRowId) => GridRowParams | Gets the [GridRowParams](/api/data-grid/grid-row-params/) object that is passed as argument in events. | +| getRowParams | (id: GridRowId) => GridRowParams | Gets the [GridRowParams](/x/api/data-grid/grid-row-params/) object that is passed as argument in events. | | getRowsCount | () => number | Gets the total number of rows in the grid. | | getScrollPosition | () => GridScrollParams | Returns the current scroll position. | | getSelectedRows | () => Map<GridRowId, GridRowModel> | Returns an array of the selected rows. | @@ -113,4 +113,4 @@ import { GridApi } from '@mui/x-data-grid-pro'; | updateColumn | (col: GridColDef) => void | Updates the definition of a column. | | updateColumns | (cols: GridColDef[]) => void | Updates the definition of multiple columns at the same time. | | updateRows | (updates: GridRowModelUpdate[]) => void | Allows to updates, insert and delete rows in a single call. | -| upsertFilterItem | (item: GridFilterItem) => void | Updates or inserts a [GridFilterItem](/api/data-grid/grid-filter-item/). | +| upsertFilterItem | (item: GridFilterItem) => void | Updates or inserts a [GridFilterItem](/x/api/data-grid/grid-filter-item/). | diff --git a/docs/pages/x/api/data-grid/grid-cell-params.md b/docs/pages/x/api/data-grid/grid-cell-params.md index 3f67a45ba221..2f89b3faa92f 100644 --- a/docs/pages/x/api/data-grid/grid-cell-params.md +++ b/docs/pages/x/api/data-grid/grid-cell-params.md @@ -1,6 +1,6 @@ # GridCellParams Interface -

                                                  Object passed as parameter in the column GridColDef cell renderer.

                                                  +

                                                  Object passed as parameter in the column GridColDef cell renderer.

                                                  ## Import diff --git a/docs/pages/x/api/data-grid/grid-col-def.md b/docs/pages/x/api/data-grid/grid-col-def.md index 6d51eda8058a..9625d1a88082 100644 --- a/docs/pages/x/api/data-grid/grid-col-def.md +++ b/docs/pages/x/api/data-grid/grid-col-def.md @@ -43,7 +43,7 @@ import { GridColDef } from '@mui/x-data-grid'; | sortable? | boolean | true | If `true`, the column is sortable. | | sortComparator? | GridComparatorFn<V> | | A comparator function used to sort rows. | | sortingOrder? | GridSortDirection[] | | The order of the sorting sequence. | -| type? | GridColType | 'string' | Type allows to merge this object with a default definition [GridColDef](/api/data-grid/grid-col-def/). | +| type? | GridColType | 'string' | Type allows to merge this object with a default definition [GridColDef](/x/api/data-grid/grid-col-def/). | | valueFormatter? | (params: GridValueFormatterParams<V>) => F | | Function that allows to apply a formatter before rendering its value. | | valueGetter? | (params: GridValueGetterParams<any, R>) => V | | Function that allows to get a specific data instead of field to render in the cell. | | valueOptions? | Array<ValueOptions> \| ((params: GridValueOptionsParams<R>) => Array<ValueOptions>) | | To be used in combination with `type: 'singleSelect'`. This is an array (or a function returning an array) of the possible cell values and labels. | diff --git a/docs/pages/x/api/data-grid/grid-filter-api.json b/docs/pages/x/api/data-grid/grid-filter-api.json index a3518180829e..c2d43d9fb071 100644 --- a/docs/pages/x/api/data-grid/grid-filter-api.json +++ b/docs/pages/x/api/data-grid/grid-filter-api.json @@ -4,7 +4,7 @@ "properties": [ { "name": "deleteFilterItem", - "description": "Deletes a GridFilterItem.", + "description": "Deletes a GridFilterItem.", "type": "(item: GridFilterItem) => void" }, { @@ -30,7 +30,7 @@ }, { "name": "upsertFilterItem", - "description": "Updates or inserts a GridFilterItem.", + "description": "Updates or inserts a GridFilterItem.", "type": "(item: GridFilterItem) => void" } ] diff --git a/docs/pages/x/api/date-pickers/index.md b/docs/pages/x/api/date-pickers/index.md index c4d92d1d83a0..f2549556b643 100644 --- a/docs/pages/x/api/date-pickers/index.md +++ b/docs/pages/x/api/date-pickers/index.md @@ -4,27 +4,27 @@ ## Components -- [CalendarPicker](/x/api/date-pickers/calendar-picker) -- [CalendarPickerSkeleton](/x/api/date-pickers/calendar-picker-skeleton) -- [ClockPicker](/x/api/date-pickers/clock-picker) -- [DatePicker](/x/api/date-pickers/date-picker) -- [DateRangePicker](/x/api/date-pickers/date-range-picker) -- [DateRangePickerDay](/x/api/date-pickers/date-range-picker-day) -- [DateTimePicker](/x/api/date-pickers/date-time-picker) -- [DesktopDatePicker](/x/api/date-pickers/desktop-date-picker) -- [DesktopDateRangePicker](/x/api/date-pickers/desktop-date-range-picker) -- [DesktopDateTimePicker](/x/api/date-pickers/desktop-date-time-picker) -- [DesktopTimePicker](/x/api/date-pickers/desktop-time-picker) -- [LocalizationProvider](/x/api/date-pickers/localization-provider) -- [MobileDatePicker](/x/api/date-pickers/mobile-date-picker) -- [MobileDateRangePicker](/x/api/date-pickers/mobile-date-range-picker) -- [MobileDateTimePicker](/x/api/date-pickers/mobile-date-time-picker) -- [MobileTimePicker](/x/api/date-pickers/mobile-time-picker) -- [MonthPicker](/x/api/date-pickers/month-picker) -- [PickersDay](/x/api/date-pickers/pickers-day) -- [StaticDatePicker](/x/api/date-pickers/static-date-picker) -- [StaticDateRangePicker](/x/api/date-pickers/static-date-range-picker) -- [StaticDateTimePicker](/x/api/date-pickers/static-date-time-picker) -- [StaticTimePicker](/x/api/date-pickers/static-time-picker) -- [TimePicker](/x/api/date-pickers/time-picker) -- [YearPicker](/x/api/date-pickers/year-picker) +- [CalendarPicker](/x/api/date-pickers/calendar-picker/) +- [CalendarPickerSkeleton](/x/api/date-pickers/calendar-picker-skeleton/) +- [ClockPicker](/x/api/date-pickers/clock-picker/) +- [DatePicker](/x/api/date-pickers/date-picker/) +- [DateRangePicker](/x/api/date-pickers/date-range-picker/) +- [DateRangePickerDay](/x/api/date-pickers/date-range-picker-day/) +- [DateTimePicker](/x/api/date-pickers/date-time-picker/) +- [DesktopDatePicker](/x/api/date-pickers/desktop-date-picker/) +- [DesktopDateRangePicker](/x/api/date-pickers/desktop-date-range-picker/) +- [DesktopDateTimePicker](/x/api/date-pickers/desktop-date-time-picker/) +- [DesktopTimePicker](/x/api/date-pickers/desktop-time-picker/) +- [LocalizationProvider](/x/api/date-pickers/localization-provider/) +- [MobileDatePicker](/x/api/date-pickers/mobile-date-picker/) +- [MobileDateRangePicker](/x/api/date-pickers/mobile-date-range-picker/) +- [MobileDateTimePicker](/x/api/date-pickers/mobile-date-time-picker/) +- [MobileTimePicker](/x/api/date-pickers/mobile-time-picker/) +- [MonthPicker](/x/api/date-pickers/month-picker/) +- [PickersDay](/x/api/date-pickers/pickers-day/) +- [StaticDatePicker](/x/api/date-pickers/static-date-picker/) +- [StaticDateRangePicker](/x/api/date-pickers/static-date-range-picker/) +- [StaticDateTimePicker](/x/api/date-pickers/static-date-time-picker/) +- [StaticTimePicker](/x/api/date-pickers/static-time-picker/) +- [TimePicker](/x/api/date-pickers/time-picker/) +- [YearPicker](/x/api/date-pickers/year-picker/) diff --git a/docs/pages/components/data-grid/editing-legacy.js b/docs/pages/x/react-data-grid/editing-legacy.js similarity index 100% rename from docs/pages/components/data-grid/editing-legacy.js rename to docs/pages/x/react-data-grid/editing-legacy.js diff --git a/docs/public/_redirects b/docs/public/_redirects index 32ab47d54659..da9fffbf60d4 100644 --- a/docs/public/_redirects +++ b/docs/public/_redirects @@ -10,7 +10,7 @@ # Redirections -/ /components/data-grid/ +/ /x/react-data-grid/ ## Redirections have to be done in the core repository, it owns the domain name. ## e.g. https://github.com/mui/material-ui/blob/HEAD/docs/public/_redirects#L31 diff --git a/docs/scripts/postMigration.ts b/docs/scripts/postMigration.ts index d8e6b63fec88..398c3d3044f4 100644 --- a/docs/scripts/postMigration.ts +++ b/docs/scripts/postMigration.ts @@ -113,12 +113,7 @@ function run() { const redirectsPath = path.join(process.cwd(), 'docs/public/_redirects'); let redirects = fs.readFileSync(redirectsPath, { encoding: 'utf8' }); - redirects = redirects.replace( - `/ /components/data-grid/`, - `/ /x/react-data-grid/ 301 -/components/data-grid/* /x/react-data-grid/:splat 301 -/api/data-grid/* /x/api/data-grid/:splat 301`, - ); + redirects = redirects.replace(`/ /components/data-grid/`, `/ /x/react-data-grid/`); fs.writeFileSync(redirectsPath, redirects); } diff --git a/docs/src/featureToggle.js b/docs/src/featureToggle.js index 6c7e1d9ebb4d..c901a874c5e4 100644 --- a/docs/src/featureToggle.js +++ b/docs/src/featureToggle.js @@ -1,4 +1,4 @@ module.exports = { enable_product_scope: true, - enable_redirects: false, + enable_redirects: true, }; diff --git a/docs/src/pages/components/data-grid/events/events.json b/docs/src/pages/components/data-grid/events/events.json index 1e3bc909effc..e61873a789a6 100644 --- a/docs/src/pages/components/data-grid/events/events.json +++ b/docs/src/pages/components/data-grid/events/events.json @@ -229,13 +229,13 @@ }, { "name": "rowMouseEnter", - "description": "Fired when the mouse enters the row. Called with a GridRowParams object.", + "description": "Fired when the mouse enters the row. Called with a GridRowParams object.", "params": "GridRowParams", "event": "MuiEvent>" }, { "name": "rowMouseLeave", - "description": "Fired when the mouse leaves the row. Called with a GridRowParams object.", + "description": "Fired when the mouse leaves the row. Called with a GridRowParams object.", "params": "GridRowParams", "event": "MuiEvent>" }, diff --git a/docs/translations/api-docs/data-grid/data-grid-pro-pt.json b/docs/translations/api-docs/data-grid/data-grid-pro-pt.json index 04387a53378a..1c7154af4741 100644 --- a/docs/translations/api-docs/data-grid/data-grid-pro-pt.json +++ b/docs/translations/api-docs/data-grid/data-grid-pro-pt.json @@ -13,7 +13,7 @@ "columns": "Set of columns of type GridColumns.", "columnThreshold": "Number of rows from the columnBuffer that can be visible before a new slice is rendered.", "columnTypes": "Extend native column types with your new column types.", - "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", + "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", "components": "Overrideable components.", "componentsProps": "Overrideable components props dynamically passed to the component at rendering.", "defaultGroupingExpansionDepth": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded.", @@ -41,13 +41,13 @@ "experimentalFeatures": "Features under development. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.", "filterMode": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.", "filterModel": "Set the filter model of the grid.", - "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", - "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", - "getDetailPanelHeight": "Function that returns the height of the row detail panel.

                                                  Signature:
                                                  function(params: GridRowParams) => number
                                                  params: With all properties from GridRowParams.
                                                  returns (number): The height in pixels.", - "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", + "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", + "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", + "getDetailPanelHeight": "Function that returns the height of the row detail panel.

                                                  Signature:
                                                  function(params: GridRowParams) => number
                                                  params: With all properties from GridRowParams.
                                                  returns (number): The height in pixels.", + "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", "getRowHeight": "Function that sets the row height per row.

                                                  Signature:
                                                  function(params: GridRowHeightParams) => GridRowHeightReturnValue
                                                  params: With all properties from GridRowHeightParams.
                                                  returns (GridRowHeightReturnValue): The row height value. If null or undefined then the default row height is applied.", "getRowId": "Return the id of a given GridRowModel.", - "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", + "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", "getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"]. Note that all paths must contain at least one element.

                                                  Signature:
                                                  function(row: R) => Array<string>
                                                  row: The row from which we want the path.
                                                  returns (Array): The path to the row.", "groupingColDef": "The grouping column used by the tree data.", "headerHeight": "Set the height in pixel of the column headers in the grid.", @@ -56,21 +56,21 @@ "hideFooterRowCount": "If true, the row count in the footer is hidden. It has no effect if the pagination is enabled.", "hideFooterSelectedRowCount": "If true, the selected row count in the footer is hidden.", "initialState": "The initial state of the DataGridPro. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.", - "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", + "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", "isGroupExpandedByDefault": "Determines if a group should be expanded after its creation. This prop takes priority over the defaultGroupingExpansionDepth prop.

                                                  Signature:
                                                  function(node: GridRowTreeNodeConfig) => boolean
                                                  node: The node of the group to test.
                                                  returns (boolean): A boolean indicating if the group is expanded.", - "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", + "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", "loading": "If true, a loading overlay is displayed.", "localeText": "Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.", "logger": "Pass a custom logger in the components that implements the Logger interface.", "logLevel": "Allows to pass the logging level or false to turn off logging.", "nonce": "Nonce of the inline styles for Content Security Policy.", - "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onCellEditCommit": "Callback fired when the cell changes are committed.

                                                  Signature:
                                                  function(params: GridCellEditCommitParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellEditCommitParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", - "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderClick": "Callback fired when a click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", @@ -86,7 +86,7 @@ "onEditCellPropsChange": "Callback fired when the edit cell value changes.

                                                  Signature:
                                                  function(params: GridEditCellPropsParams, event: MuiEvent<React.SyntheticEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridEditCellPropsParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", "onEditRowsModelChange": "Callback fired when the editRowsModel changes.

                                                  Signature:
                                                  function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void
                                                  editRowsModel: With all properties from GridEditRowsModel.
                                                  details: Additional details for this callback.", "onError": "Callback fired when an exception is thrown in the grid.

                                                  Signature:
                                                  function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  args: The arguments passed to the showError call.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", + "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", "onPageChange": "Callback fired when the current page has changed.

                                                  Signature:
                                                  function(page: number, details: GridCallbackDetails) => void
                                                  page: Index of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPageSizeChange": "Callback fired when the page size has changed.

                                                  Signature:
                                                  function(pageSize: number, details: GridCallbackDetails) => void
                                                  pageSize: Size of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPinnedColumnsChange": "Callback fired when the pinned columns have changed.

                                                  Signature:
                                                  function(pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => void
                                                  pinnedColumns: The changed pinned columns.
                                                  details: Additional details for this callback.", @@ -94,11 +94,11 @@ "onPreferencePanelOpen": "Callback fired when the preferences panel is opened.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onProcessRowUpdateError": "Callback called when processRowUpdate throws an error or rejects.

                                                  Signature:
                                                  function(error: any) => void
                                                  error: The error thrown.", "onResize": "Callback fired when the grid is resized.

                                                  Signature:
                                                  function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  containerSize: With all properties from ElementSize.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowDoubleClick": "Callback fired when a double click event comes from a row container element.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from RowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowEditCommit": "Callback fired when the row changes are committed.

                                                  Signature:
                                                  function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void
                                                  id: The row id.
                                                  event: The event that caused this prop to be called.", - "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", - "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", "onRowGroupingModelChange": "Callback fired when the row grouping model changes.

                                                  Signature:
                                                  function(model: GridRowGroupingModel, details: GridCallbackDetails) => void
                                                  model: Columns used as grouping criteria.
                                                  details: Additional details for this callback.", "onRowsScrollEnd": "Callback fired when scrolling to the bottom of the grid viewport.

                                                  Signature:
                                                  function(params: GridRowScrollEndParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowScrollEndParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.

                                                  Signature:
                                                  function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void
                                                  selectionModel: With all the row ids GridSelectionModel.
                                                  details: Additional details for this callback.", diff --git a/docs/translations/api-docs/data-grid/data-grid-pro-zh.json b/docs/translations/api-docs/data-grid/data-grid-pro-zh.json index 04387a53378a..1c7154af4741 100644 --- a/docs/translations/api-docs/data-grid/data-grid-pro-zh.json +++ b/docs/translations/api-docs/data-grid/data-grid-pro-zh.json @@ -13,7 +13,7 @@ "columns": "Set of columns of type GridColumns.", "columnThreshold": "Number of rows from the columnBuffer that can be visible before a new slice is rendered.", "columnTypes": "Extend native column types with your new column types.", - "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", + "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", "components": "Overrideable components.", "componentsProps": "Overrideable components props dynamically passed to the component at rendering.", "defaultGroupingExpansionDepth": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded.", @@ -41,13 +41,13 @@ "experimentalFeatures": "Features under development. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.", "filterMode": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.", "filterModel": "Set the filter model of the grid.", - "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", - "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", - "getDetailPanelHeight": "Function that returns the height of the row detail panel.

                                                  Signature:
                                                  function(params: GridRowParams) => number
                                                  params: With all properties from GridRowParams.
                                                  returns (number): The height in pixels.", - "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", + "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", + "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", + "getDetailPanelHeight": "Function that returns the height of the row detail panel.

                                                  Signature:
                                                  function(params: GridRowParams) => number
                                                  params: With all properties from GridRowParams.
                                                  returns (number): The height in pixels.", + "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", "getRowHeight": "Function that sets the row height per row.

                                                  Signature:
                                                  function(params: GridRowHeightParams) => GridRowHeightReturnValue
                                                  params: With all properties from GridRowHeightParams.
                                                  returns (GridRowHeightReturnValue): The row height value. If null or undefined then the default row height is applied.", "getRowId": "Return the id of a given GridRowModel.", - "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", + "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", "getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"]. Note that all paths must contain at least one element.

                                                  Signature:
                                                  function(row: R) => Array<string>
                                                  row: The row from which we want the path.
                                                  returns (Array): The path to the row.", "groupingColDef": "The grouping column used by the tree data.", "headerHeight": "Set the height in pixel of the column headers in the grid.", @@ -56,21 +56,21 @@ "hideFooterRowCount": "If true, the row count in the footer is hidden. It has no effect if the pagination is enabled.", "hideFooterSelectedRowCount": "If true, the selected row count in the footer is hidden.", "initialState": "The initial state of the DataGridPro. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.", - "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", + "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", "isGroupExpandedByDefault": "Determines if a group should be expanded after its creation. This prop takes priority over the defaultGroupingExpansionDepth prop.

                                                  Signature:
                                                  function(node: GridRowTreeNodeConfig) => boolean
                                                  node: The node of the group to test.
                                                  returns (boolean): A boolean indicating if the group is expanded.", - "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", + "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", "loading": "If true, a loading overlay is displayed.", "localeText": "Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.", "logger": "Pass a custom logger in the components that implements the Logger interface.", "logLevel": "Allows to pass the logging level or false to turn off logging.", "nonce": "Nonce of the inline styles for Content Security Policy.", - "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onCellEditCommit": "Callback fired when the cell changes are committed.

                                                  Signature:
                                                  function(params: GridCellEditCommitParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellEditCommitParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", - "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderClick": "Callback fired when a click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", @@ -86,7 +86,7 @@ "onEditCellPropsChange": "Callback fired when the edit cell value changes.

                                                  Signature:
                                                  function(params: GridEditCellPropsParams, event: MuiEvent<React.SyntheticEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridEditCellPropsParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", "onEditRowsModelChange": "Callback fired when the editRowsModel changes.

                                                  Signature:
                                                  function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void
                                                  editRowsModel: With all properties from GridEditRowsModel.
                                                  details: Additional details for this callback.", "onError": "Callback fired when an exception is thrown in the grid.

                                                  Signature:
                                                  function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  args: The arguments passed to the showError call.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", + "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", "onPageChange": "Callback fired when the current page has changed.

                                                  Signature:
                                                  function(page: number, details: GridCallbackDetails) => void
                                                  page: Index of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPageSizeChange": "Callback fired when the page size has changed.

                                                  Signature:
                                                  function(pageSize: number, details: GridCallbackDetails) => void
                                                  pageSize: Size of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPinnedColumnsChange": "Callback fired when the pinned columns have changed.

                                                  Signature:
                                                  function(pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => void
                                                  pinnedColumns: The changed pinned columns.
                                                  details: Additional details for this callback.", @@ -94,11 +94,11 @@ "onPreferencePanelOpen": "Callback fired when the preferences panel is opened.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onProcessRowUpdateError": "Callback called when processRowUpdate throws an error or rejects.

                                                  Signature:
                                                  function(error: any) => void
                                                  error: The error thrown.", "onResize": "Callback fired when the grid is resized.

                                                  Signature:
                                                  function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  containerSize: With all properties from ElementSize.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowDoubleClick": "Callback fired when a double click event comes from a row container element.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from RowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowEditCommit": "Callback fired when the row changes are committed.

                                                  Signature:
                                                  function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void
                                                  id: The row id.
                                                  event: The event that caused this prop to be called.", - "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", - "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", "onRowGroupingModelChange": "Callback fired when the row grouping model changes.

                                                  Signature:
                                                  function(model: GridRowGroupingModel, details: GridCallbackDetails) => void
                                                  model: Columns used as grouping criteria.
                                                  details: Additional details for this callback.", "onRowsScrollEnd": "Callback fired when scrolling to the bottom of the grid viewport.

                                                  Signature:
                                                  function(params: GridRowScrollEndParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowScrollEndParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.

                                                  Signature:
                                                  function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void
                                                  selectionModel: With all the row ids GridSelectionModel.
                                                  details: Additional details for this callback.", diff --git a/docs/translations/api-docs/data-grid/data-grid-pro.json b/docs/translations/api-docs/data-grid/data-grid-pro.json index 04387a53378a..1c7154af4741 100644 --- a/docs/translations/api-docs/data-grid/data-grid-pro.json +++ b/docs/translations/api-docs/data-grid/data-grid-pro.json @@ -13,7 +13,7 @@ "columns": "Set of columns of type GridColumns.", "columnThreshold": "Number of rows from the columnBuffer that can be visible before a new slice is rendered.", "columnTypes": "Extend native column types with your new column types.", - "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", + "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", "components": "Overrideable components.", "componentsProps": "Overrideable components props dynamically passed to the component at rendering.", "defaultGroupingExpansionDepth": "If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded.", @@ -41,13 +41,13 @@ "experimentalFeatures": "Features under development. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.", "filterMode": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.", "filterModel": "Set the filter model of the grid.", - "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", - "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", - "getDetailPanelHeight": "Function that returns the height of the row detail panel.

                                                  Signature:
                                                  function(params: GridRowParams) => number
                                                  params: With all properties from GridRowParams.
                                                  returns (number): The height in pixels.", - "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", + "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", + "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", + "getDetailPanelHeight": "Function that returns the height of the row detail panel.

                                                  Signature:
                                                  function(params: GridRowParams) => number
                                                  params: With all properties from GridRowParams.
                                                  returns (number): The height in pixels.", + "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", "getRowHeight": "Function that sets the row height per row.

                                                  Signature:
                                                  function(params: GridRowHeightParams) => GridRowHeightReturnValue
                                                  params: With all properties from GridRowHeightParams.
                                                  returns (GridRowHeightReturnValue): The row height value. If null or undefined then the default row height is applied.", "getRowId": "Return the id of a given GridRowModel.", - "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", + "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", "getTreeDataPath": "Determines the path of a row in the tree data. For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"]. Note that all paths must contain at least one element.

                                                  Signature:
                                                  function(row: R) => Array<string>
                                                  row: The row from which we want the path.
                                                  returns (Array): The path to the row.", "groupingColDef": "The grouping column used by the tree data.", "headerHeight": "Set the height in pixel of the column headers in the grid.", @@ -56,21 +56,21 @@ "hideFooterRowCount": "If true, the row count in the footer is hidden. It has no effect if the pagination is enabled.", "hideFooterSelectedRowCount": "If true, the selected row count in the footer is hidden.", "initialState": "The initial state of the DataGridPro. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.", - "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", + "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", "isGroupExpandedByDefault": "Determines if a group should be expanded after its creation. This prop takes priority over the defaultGroupingExpansionDepth prop.

                                                  Signature:
                                                  function(node: GridRowTreeNodeConfig) => boolean
                                                  node: The node of the group to test.
                                                  returns (boolean): A boolean indicating if the group is expanded.", - "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", + "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", "loading": "If true, a loading overlay is displayed.", "localeText": "Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.", "logger": "Pass a custom logger in the components that implements the Logger interface.", "logLevel": "Allows to pass the logging level or false to turn off logging.", "nonce": "Nonce of the inline styles for Content Security Policy.", - "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onCellEditCommit": "Callback fired when the cell changes are committed.

                                                  Signature:
                                                  function(params: GridCellEditCommitParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellEditCommitParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", - "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderClick": "Callback fired when a click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", @@ -86,7 +86,7 @@ "onEditCellPropsChange": "Callback fired when the edit cell value changes.

                                                  Signature:
                                                  function(params: GridEditCellPropsParams, event: MuiEvent<React.SyntheticEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridEditCellPropsParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", "onEditRowsModelChange": "Callback fired when the editRowsModel changes.

                                                  Signature:
                                                  function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void
                                                  editRowsModel: With all properties from GridEditRowsModel.
                                                  details: Additional details for this callback.", "onError": "Callback fired when an exception is thrown in the grid.

                                                  Signature:
                                                  function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  args: The arguments passed to the showError call.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", + "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", "onPageChange": "Callback fired when the current page has changed.

                                                  Signature:
                                                  function(page: number, details: GridCallbackDetails) => void
                                                  page: Index of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPageSizeChange": "Callback fired when the page size has changed.

                                                  Signature:
                                                  function(pageSize: number, details: GridCallbackDetails) => void
                                                  pageSize: Size of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPinnedColumnsChange": "Callback fired when the pinned columns have changed.

                                                  Signature:
                                                  function(pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => void
                                                  pinnedColumns: The changed pinned columns.
                                                  details: Additional details for this callback.", @@ -94,11 +94,11 @@ "onPreferencePanelOpen": "Callback fired when the preferences panel is opened.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onProcessRowUpdateError": "Callback called when processRowUpdate throws an error or rejects.

                                                  Signature:
                                                  function(error: any) => void
                                                  error: The error thrown.", "onResize": "Callback fired when the grid is resized.

                                                  Signature:
                                                  function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  containerSize: With all properties from ElementSize.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowDoubleClick": "Callback fired when a double click event comes from a row container element.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from RowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowEditCommit": "Callback fired when the row changes are committed.

                                                  Signature:
                                                  function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void
                                                  id: The row id.
                                                  event: The event that caused this prop to be called.", - "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", - "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", "onRowGroupingModelChange": "Callback fired when the row grouping model changes.

                                                  Signature:
                                                  function(model: GridRowGroupingModel, details: GridCallbackDetails) => void
                                                  model: Columns used as grouping criteria.
                                                  details: Additional details for this callback.", "onRowsScrollEnd": "Callback fired when scrolling to the bottom of the grid viewport.

                                                  Signature:
                                                  function(params: GridRowScrollEndParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowScrollEndParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.

                                                  Signature:
                                                  function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void
                                                  selectionModel: With all the row ids GridSelectionModel.
                                                  details: Additional details for this callback.", diff --git a/docs/translations/api-docs/data-grid/data-grid-pt.json b/docs/translations/api-docs/data-grid/data-grid-pt.json index b816274c6f7e..a350de0ff01e 100644 --- a/docs/translations/api-docs/data-grid/data-grid-pt.json +++ b/docs/translations/api-docs/data-grid/data-grid-pt.json @@ -11,7 +11,7 @@ "columns": "Set of columns of type GridColumns.", "columnThreshold": "Number of rows from the columnBuffer that can be visible before a new slice is rendered.", "columnTypes": "Extend native column types with your new column types.", - "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", + "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", "components": "Overrideable components.", "componentsProps": "Overrideable components props dynamically passed to the component at rendering.", "density": "Set the density of the grid.", @@ -28,31 +28,31 @@ "experimentalFeatures": "Features under development. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.", "filterMode": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.", "filterModel": "Set the filter model of the grid.", - "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", - "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", - "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", + "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", + "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", + "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", "getRowHeight": "Function that sets the row height per row.

                                                  Signature:
                                                  function(params: GridRowHeightParams) => GridRowHeightReturnValue
                                                  params: With all properties from GridRowHeightParams.
                                                  returns (GridRowHeightReturnValue): The row height value. If null or undefined then the default row height is applied.", "getRowId": "Return the id of a given GridRowModel.", - "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", + "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", "headerHeight": "Set the height in pixel of the column headers in the grid.", "hideFooter": "If true, the footer component is hidden.", "hideFooterPagination": "If true, the pagination component in the footer is hidden.", "hideFooterSelectedRowCount": "If true, the selected row count in the footer is hidden.", "initialState": "The initial state of the DataGrid. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.", - "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", - "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", + "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", + "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", "loading": "If true, a loading overlay is displayed.", "localeText": "Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.", "logger": "Pass a custom logger in the components that implements the Logger interface.", "logLevel": "Allows to pass the logging level or false to turn off logging.", "nonce": "Nonce of the inline styles for Content Security Policy.", - "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onCellEditCommit": "Callback fired when the cell changes are committed.

                                                  Signature:
                                                  function(params: GridCellEditCommitParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellEditCommitParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", - "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderClick": "Callback fired when a click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", @@ -65,18 +65,18 @@ "onEditCellPropsChange": "Callback fired when the edit cell value changes.

                                                  Signature:
                                                  function(params: GridEditCellPropsParams, event: MuiEvent<React.SyntheticEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridEditCellPropsParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", "onEditRowsModelChange": "Callback fired when the editRowsModel changes.

                                                  Signature:
                                                  function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void
                                                  editRowsModel: With all properties from GridEditRowsModel.
                                                  details: Additional details for this callback.", "onError": "Callback fired when an exception is thrown in the grid.

                                                  Signature:
                                                  function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  args: The arguments passed to the showError call.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", + "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", "onPageChange": "Callback fired when the current page has changed.

                                                  Signature:
                                                  function(page: number, details: GridCallbackDetails) => void
                                                  page: Index of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPageSizeChange": "Callback fired when the page size has changed.

                                                  Signature:
                                                  function(pageSize: number, details: GridCallbackDetails) => void
                                                  pageSize: Size of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPreferencePanelClose": "Callback fired when the preferences panel is closed.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onPreferencePanelOpen": "Callback fired when the preferences panel is opened.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onProcessRowUpdateError": "Callback called when processRowUpdate throws an error or rejects.

                                                  Signature:
                                                  function(error: any) => void
                                                  error: The error thrown.", "onResize": "Callback fired when the grid is resized.

                                                  Signature:
                                                  function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  containerSize: With all properties from ElementSize.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowDoubleClick": "Callback fired when a double click event comes from a row container element.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from RowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowEditCommit": "Callback fired when the row changes are committed.

                                                  Signature:
                                                  function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void
                                                  id: The row id.
                                                  event: The event that caused this prop to be called.", - "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", - "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", "onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.

                                                  Signature:
                                                  function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void
                                                  selectionModel: With all the row ids GridSelectionModel.
                                                  details: Additional details for this callback.", "onSortModelChange": "Callback fired when the sort model changes before a column is sorted.

                                                  Signature:
                                                  function(model: GridSortModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridSortModel.
                                                  details: Additional details for this callback.", "onStateChange": "Callback fired when the state of the grid is updated.

                                                  Signature:
                                                  function(state: GridState, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  state: The new state.
                                                  event: The event object.
                                                  details: Additional details for this callback.", diff --git a/docs/translations/api-docs/data-grid/data-grid-zh.json b/docs/translations/api-docs/data-grid/data-grid-zh.json index b816274c6f7e..a350de0ff01e 100644 --- a/docs/translations/api-docs/data-grid/data-grid-zh.json +++ b/docs/translations/api-docs/data-grid/data-grid-zh.json @@ -11,7 +11,7 @@ "columns": "Set of columns of type GridColumns.", "columnThreshold": "Number of rows from the columnBuffer that can be visible before a new slice is rendered.", "columnTypes": "Extend native column types with your new column types.", - "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", + "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", "components": "Overrideable components.", "componentsProps": "Overrideable components props dynamically passed to the component at rendering.", "density": "Set the density of the grid.", @@ -28,31 +28,31 @@ "experimentalFeatures": "Features under development. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.", "filterMode": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.", "filterModel": "Set the filter model of the grid.", - "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", - "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", - "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", + "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", + "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", + "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", "getRowHeight": "Function that sets the row height per row.

                                                  Signature:
                                                  function(params: GridRowHeightParams) => GridRowHeightReturnValue
                                                  params: With all properties from GridRowHeightParams.
                                                  returns (GridRowHeightReturnValue): The row height value. If null or undefined then the default row height is applied.", "getRowId": "Return the id of a given GridRowModel.", - "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", + "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", "headerHeight": "Set the height in pixel of the column headers in the grid.", "hideFooter": "If true, the footer component is hidden.", "hideFooterPagination": "If true, the pagination component in the footer is hidden.", "hideFooterSelectedRowCount": "If true, the selected row count in the footer is hidden.", "initialState": "The initial state of the DataGrid. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.", - "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", - "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", + "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", + "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", "loading": "If true, a loading overlay is displayed.", "localeText": "Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.", "logger": "Pass a custom logger in the components that implements the Logger interface.", "logLevel": "Allows to pass the logging level or false to turn off logging.", "nonce": "Nonce of the inline styles for Content Security Policy.", - "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onCellEditCommit": "Callback fired when the cell changes are committed.

                                                  Signature:
                                                  function(params: GridCellEditCommitParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellEditCommitParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", - "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderClick": "Callback fired when a click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", @@ -65,18 +65,18 @@ "onEditCellPropsChange": "Callback fired when the edit cell value changes.

                                                  Signature:
                                                  function(params: GridEditCellPropsParams, event: MuiEvent<React.SyntheticEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridEditCellPropsParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", "onEditRowsModelChange": "Callback fired when the editRowsModel changes.

                                                  Signature:
                                                  function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void
                                                  editRowsModel: With all properties from GridEditRowsModel.
                                                  details: Additional details for this callback.", "onError": "Callback fired when an exception is thrown in the grid.

                                                  Signature:
                                                  function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  args: The arguments passed to the showError call.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", + "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", "onPageChange": "Callback fired when the current page has changed.

                                                  Signature:
                                                  function(page: number, details: GridCallbackDetails) => void
                                                  page: Index of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPageSizeChange": "Callback fired when the page size has changed.

                                                  Signature:
                                                  function(pageSize: number, details: GridCallbackDetails) => void
                                                  pageSize: Size of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPreferencePanelClose": "Callback fired when the preferences panel is closed.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onPreferencePanelOpen": "Callback fired when the preferences panel is opened.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onProcessRowUpdateError": "Callback called when processRowUpdate throws an error or rejects.

                                                  Signature:
                                                  function(error: any) => void
                                                  error: The error thrown.", "onResize": "Callback fired when the grid is resized.

                                                  Signature:
                                                  function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  containerSize: With all properties from ElementSize.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowDoubleClick": "Callback fired when a double click event comes from a row container element.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from RowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowEditCommit": "Callback fired when the row changes are committed.

                                                  Signature:
                                                  function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void
                                                  id: The row id.
                                                  event: The event that caused this prop to be called.", - "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", - "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", "onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.

                                                  Signature:
                                                  function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void
                                                  selectionModel: With all the row ids GridSelectionModel.
                                                  details: Additional details for this callback.", "onSortModelChange": "Callback fired when the sort model changes before a column is sorted.

                                                  Signature:
                                                  function(model: GridSortModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridSortModel.
                                                  details: Additional details for this callback.", "onStateChange": "Callback fired when the state of the grid is updated.

                                                  Signature:
                                                  function(state: GridState, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  state: The new state.
                                                  event: The event object.
                                                  details: Additional details for this callback.", diff --git a/docs/translations/api-docs/data-grid/data-grid.json b/docs/translations/api-docs/data-grid/data-grid.json index b816274c6f7e..a350de0ff01e 100644 --- a/docs/translations/api-docs/data-grid/data-grid.json +++ b/docs/translations/api-docs/data-grid/data-grid.json @@ -11,7 +11,7 @@ "columns": "Set of columns of type GridColumns.", "columnThreshold": "Number of rows from the columnBuffer that can be visible before a new slice is rendered.", "columnTypes": "Extend native column types with your new column types.", - "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", + "columnVisibilityModel": "Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.", "components": "Overrideable components.", "componentsProps": "Overrideable components props dynamically passed to the component at rendering.", "density": "Set the density of the grid.", @@ -28,31 +28,31 @@ "experimentalFeatures": "Features under development. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.", "filterMode": "Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.", "filterModel": "Set the filter model of the grid.", - "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", - "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", - "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", + "getCellClassName": "Function that applies CSS classes dynamically on cells.

                                                  Signature:
                                                  function(params: GridCellParams) => string
                                                  params: With all properties from GridCellParams.
                                                  returns (string): The CSS class to apply to the cell.", + "getDetailPanelContent": "Function that returns the element to render in row detail.

                                                  Signature:
                                                  function(params: GridRowParams) => JSX.Element
                                                  params: With all properties from GridRowParams.
                                                  returns (JSX.Element): The row detail element.", + "getRowClassName": "Function that applies CSS classes dynamically on rows.

                                                  Signature:
                                                  function(params: GridRowClassNameParams) => string
                                                  params: With all properties from GridRowClassNameParams.
                                                  returns (string): The CSS class to apply to the row.", "getRowHeight": "Function that sets the row height per row.

                                                  Signature:
                                                  function(params: GridRowHeightParams) => GridRowHeightReturnValue
                                                  params: With all properties from GridRowHeightParams.
                                                  returns (GridRowHeightReturnValue): The row height value. If null or undefined then the default row height is applied.", "getRowId": "Return the id of a given GridRowModel.", - "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", + "getRowSpacing": "Function that allows to specify the spacing between rows.

                                                  Signature:
                                                  function(params: GridRowSpacingParams) => GridRowSpacing
                                                  params: With all properties from GridRowSpacingParams.
                                                  returns (GridRowSpacing): The row spacing values.", "headerHeight": "Set the height in pixel of the column headers in the grid.", "hideFooter": "If true, the footer component is hidden.", "hideFooterPagination": "If true, the pagination component in the footer is hidden.", "hideFooterSelectedRowCount": "If true, the selected row count in the footer is hidden.", "initialState": "The initial state of the DataGrid. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.", - "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", - "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", + "isCellEditable": "Callback fired when a cell is rendered, returns true if the cell is editable.

                                                  Signature:
                                                  function(params: GridCellParams) => boolean
                                                  params: With all properties from GridCellParams.
                                                  returns (boolean): A boolean indicating if the cell is editable.", + "isRowSelectable": "Determines if a row can be selected.

                                                  Signature:
                                                  function(params: GridRowParams) => boolean
                                                  params: With all properties from GridRowParams.
                                                  returns (boolean): A boolean indicating if the cell is selectable.", "loading": "If true, a loading overlay is displayed.", "localeText": "Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.", "logger": "Pass a custom logger in the components that implements the Logger interface.", "logLevel": "Allows to pass the logging level or false to turn off logging.", "nonce": "Nonce of the inline styles for Content Security Policy.", - "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellClick": "Callback fired when any cell is clicked.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellDoubleClick": "Callback fired when a double click event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onCellEditCommit": "Callback fired when the cell changes are committed.

                                                  Signature:
                                                  function(params: GridCellEditCommitParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellEditCommitParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", - "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", - "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellEditStart": "Callback fired when the cell turns to edit mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellEditStop": "Callback fired when the cell turns to view mode.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event that caused this prop to be called.", + "onCellFocusOut": "Callback fired when a cell loses focus.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<MuiBaseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onCellKeyDown": "Callback fired when a keydown event comes from a cell element.

                                                  Signature:
                                                  function(params: GridCellParams, event: MuiEvent<React.KeyboardEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridCellParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderClick": "Callback fired when a click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderDoubleClick": "Callback fired when a double click event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onColumnHeaderEnter": "Callback fired when a mouse enter event comes from a column header element.

                                                  Signature:
                                                  function(params: GridColumnHeaderParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridColumnHeaderParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", @@ -65,18 +65,18 @@ "onEditCellPropsChange": "Callback fired when the edit cell value changes.

                                                  Signature:
                                                  function(params: GridEditCellPropsParams, event: MuiEvent<React.SyntheticEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridEditCellPropsParams.
                                                  event: The event that caused this prop to be called.
                                                  details: Additional details for this callback.", "onEditRowsModelChange": "Callback fired when the editRowsModel changes.

                                                  Signature:
                                                  function(editRowsModel: GridEditRowsModel, details: GridCallbackDetails) => void
                                                  editRowsModel: With all properties from GridEditRowsModel.
                                                  details: Additional details for this callback.", "onError": "Callback fired when an exception is thrown in the grid.

                                                  Signature:
                                                  function(args: any, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  args: The arguments passed to the showError call.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", + "onFilterModelChange": "Callback fired when the Filter model changes before the filters are applied.

                                                  Signature:
                                                  function(model: GridFilterModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridFilterModel.
                                                  details: Additional details for this callback.", "onPageChange": "Callback fired when the current page has changed.

                                                  Signature:
                                                  function(page: number, details: GridCallbackDetails) => void
                                                  page: Index of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPageSizeChange": "Callback fired when the page size has changed.

                                                  Signature:
                                                  function(pageSize: number, details: GridCallbackDetails) => void
                                                  pageSize: Size of the page displayed on the Grid.
                                                  details: Additional details for this callback.", "onPreferencePanelClose": "Callback fired when the preferences panel is closed.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onPreferencePanelOpen": "Callback fired when the preferences panel is opened.

                                                  Signature:
                                                  function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridPreferencePanelParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onProcessRowUpdateError": "Callback called when processRowUpdate throws an error or rejects.

                                                  Signature:
                                                  function(error: any) => void
                                                  error: The error thrown.", "onResize": "Callback fired when the grid is resized.

                                                  Signature:
                                                  function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  containerSize: With all properties from ElementSize.
                                                  event: The event object.
                                                  details: Additional details for this callback.", - "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", + "onRowClick": "Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowDoubleClick": "Callback fired when a double click event comes from a row container element.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.MouseEvent>, details: GridCallbackDetails) => void
                                                  params: With all properties from RowParams.
                                                  event: The event object.
                                                  details: Additional details for this callback.", "onRowEditCommit": "Callback fired when the row changes are committed.

                                                  Signature:
                                                  function(id: GridRowId, event: MuiEvent<MuiBaseEvent>) => void
                                                  id: The row id.
                                                  event: The event that caused this prop to be called.", - "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", - "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStart": "Callback fired when the row turns to edit mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<React.KeyboardEvent | React.MouseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", + "onRowEditStop": "Callback fired when the row turns to view mode.

                                                  Signature:
                                                  function(params: GridRowParams, event: MuiEvent<MuiBaseEvent>) => void
                                                  params: With all properties from GridRowParams.
                                                  event: The event that caused this prop to be called.", "onSelectionModelChange": "Callback fired when the selection state of one or multiple rows changes.

                                                  Signature:
                                                  function(selectionModel: GridSelectionModel, details: GridCallbackDetails) => void
                                                  selectionModel: With all the row ids GridSelectionModel.
                                                  details: Additional details for this callback.", "onSortModelChange": "Callback fired when the sort model changes before a column is sorted.

                                                  Signature:
                                                  function(model: GridSortModel, details: GridCallbackDetails) => void
                                                  model: With all properties from GridSortModel.
                                                  details: Additional details for this callback.", "onStateChange": "Callback fired when the state of the grid is updated.

                                                  Signature:
                                                  function(state: GridState, event: MuiEvent<{}>, details: GridCallbackDetails) => void
                                                  state: The new state.
                                                  event: The event object.
                                                  details: Additional details for this callback.", diff --git a/docs/translations/api-docs/date-pickers/calendar-picker-pt.json b/docs/translations/api-docs/date-pickers/calendar-picker-pt.json index cb15fc16a4e9..fb00d3c3d847 100644 --- a/docs/translations/api-docs/date-pickers/calendar-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/calendar-picker-pt.json @@ -19,7 +19,7 @@ "openTo": "Initially open view.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rightArrowButtonText": "Right arrow icon aria-label text.", "shouldDisableDate": "Disable specific date. @DateIOType

                                                  Signature:
                                                  function(day: TDate) => boolean
                                                  day: The date to check.
                                                  returns (boolean): If true the day will be disabled.", diff --git a/docs/translations/api-docs/date-pickers/calendar-picker-zh.json b/docs/translations/api-docs/date-pickers/calendar-picker-zh.json index cb15fc16a4e9..fb00d3c3d847 100644 --- a/docs/translations/api-docs/date-pickers/calendar-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/calendar-picker-zh.json @@ -19,7 +19,7 @@ "openTo": "Initially open view.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rightArrowButtonText": "Right arrow icon aria-label text.", "shouldDisableDate": "Disable specific date. @DateIOType

                                                  Signature:
                                                  function(day: TDate) => boolean
                                                  day: The date to check.
                                                  returns (boolean): If true the day will be disabled.", diff --git a/docs/translations/api-docs/date-pickers/calendar-picker.json b/docs/translations/api-docs/date-pickers/calendar-picker.json index cb15fc16a4e9..fb00d3c3d847 100644 --- a/docs/translations/api-docs/date-pickers/calendar-picker.json +++ b/docs/translations/api-docs/date-pickers/calendar-picker.json @@ -19,7 +19,7 @@ "openTo": "Initially open view.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rightArrowButtonText": "Right arrow icon aria-label text.", "shouldDisableDate": "Disable specific date. @DateIOType

                                                  Signature:
                                                  function(day: TDate) => boolean
                                                  day: The date to check.
                                                  returns (boolean): If true the day will be disabled.", diff --git a/docs/translations/api-docs/date-pickers/date-picker-pt.json b/docs/translations/api-docs/date-pickers/date-picker-pt.json index 0dc81ff45320..f44f33bd1a01 100644 --- a/docs/translations/api-docs/date-pickers/date-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/date-picker-pt.json @@ -11,7 +11,7 @@ "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -40,12 +40,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -59,7 +59,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/date-picker-zh.json b/docs/translations/api-docs/date-pickers/date-picker-zh.json index 0dc81ff45320..f44f33bd1a01 100644 --- a/docs/translations/api-docs/date-pickers/date-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/date-picker-zh.json @@ -11,7 +11,7 @@ "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -40,12 +40,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -59,7 +59,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/date-picker.json b/docs/translations/api-docs/date-pickers/date-picker.json index 0dc81ff45320..f44f33bd1a01 100644 --- a/docs/translations/api-docs/date-pickers/date-picker.json +++ b/docs/translations/api-docs/date-pickers/date-picker.json @@ -11,7 +11,7 @@ "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -40,12 +40,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -59,7 +59,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/date-range-picker-pt.json index 7392a5a907df..56ae2bcab958 100644 --- a/docs/translations/api-docs/date-pickers/date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/date-range-picker-pt.json @@ -12,7 +12,7 @@ "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableAutoMonthSwitching": "If true, after selecting start date calendar will not automatically switch to the month of end date.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", @@ -41,12 +41,12 @@ "open": "Control the popup or dialog open state.", "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -61,7 +61,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the date range picker." }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/date-pickers/date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/date-range-picker-zh.json index 7392a5a907df..56ae2bcab958 100644 --- a/docs/translations/api-docs/date-pickers/date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/date-range-picker-zh.json @@ -12,7 +12,7 @@ "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableAutoMonthSwitching": "If true, after selecting start date calendar will not automatically switch to the month of end date.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", @@ -41,12 +41,12 @@ "open": "Control the popup or dialog open state.", "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -61,7 +61,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the date range picker." }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/date-pickers/date-range-picker.json b/docs/translations/api-docs/date-pickers/date-range-picker.json index 7392a5a907df..56ae2bcab958 100644 --- a/docs/translations/api-docs/date-pickers/date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/date-range-picker.json @@ -12,7 +12,7 @@ "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableAutoMonthSwitching": "If true, after selecting start date calendar will not automatically switch to the month of end date.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", @@ -41,12 +41,12 @@ "open": "Control the popup or dialog open state.", "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -61,7 +61,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the date range picker." }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/date-pickers/date-time-picker-pt.json b/docs/translations/api-docs/date-pickers/date-time-picker-pt.json index 5997e7dc1525..601e8560445c 100644 --- a/docs/translations/api-docs/date-pickers/date-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/date-time-picker-pt.json @@ -14,7 +14,7 @@ "dateRangeIcon": "Date tab icon.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -51,12 +51,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -72,7 +72,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/date-time-picker-zh.json b/docs/translations/api-docs/date-pickers/date-time-picker-zh.json index 5997e7dc1525..601e8560445c 100644 --- a/docs/translations/api-docs/date-pickers/date-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/date-time-picker-zh.json @@ -14,7 +14,7 @@ "dateRangeIcon": "Date tab icon.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -51,12 +51,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -72,7 +72,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/date-time-picker.json b/docs/translations/api-docs/date-pickers/date-time-picker.json index 5997e7dc1525..601e8560445c 100644 --- a/docs/translations/api-docs/date-pickers/date-time-picker.json +++ b/docs/translations/api-docs/date-pickers/date-time-picker.json @@ -14,7 +14,7 @@ "dateRangeIcon": "Date tab icon.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -51,12 +51,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -72,7 +72,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-picker-pt.json b/docs/translations/api-docs/date-pickers/desktop-date-picker-pt.json index 95220178a73a..f6cfa4d40cbe 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-picker-pt.json @@ -36,12 +36,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -53,7 +53,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-picker-zh.json b/docs/translations/api-docs/date-pickers/desktop-date-picker-zh.json index 95220178a73a..f6cfa4d40cbe 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-picker-zh.json @@ -36,12 +36,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -53,7 +53,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-picker.json index 95220178a73a..f6cfa4d40cbe 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-picker.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-picker.json @@ -36,12 +36,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -53,7 +53,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json index 38d9a2d742b2..c34fe76d4db2 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-pt.json @@ -37,12 +37,12 @@ "open": "Control the popup or dialog open state.", "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -55,7 +55,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the date range picker." }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json index 38d9a2d742b2..c34fe76d4db2 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-range-picker-zh.json @@ -37,12 +37,12 @@ "open": "Control the popup or dialog open state.", "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -55,7 +55,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the date range picker." }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json index 38d9a2d742b2..c34fe76d4db2 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-range-picker.json @@ -37,12 +37,12 @@ "open": "Control the popup or dialog open state.", "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -55,7 +55,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the date range picker." }, "classDescriptions": {}, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-time-picker-pt.json b/docs/translations/api-docs/date-pickers/desktop-date-time-picker-pt.json index a1b30312f27a..99ac79e4b266 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-time-picker-pt.json @@ -47,12 +47,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -66,7 +66,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-time-picker-zh.json b/docs/translations/api-docs/date-pickers/desktop-date-time-picker-zh.json index a1b30312f27a..99ac79e4b266 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-time-picker-zh.json @@ -47,12 +47,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -66,7 +66,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-date-time-picker.json b/docs/translations/api-docs/date-pickers/desktop-date-time-picker.json index a1b30312f27a..99ac79e4b266 100644 --- a/docs/translations/api-docs/date-pickers/desktop-date-time-picker.json +++ b/docs/translations/api-docs/date-pickers/desktop-date-time-picker.json @@ -47,12 +47,12 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", @@ -66,7 +66,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-time-picker-pt.json b/docs/translations/api-docs/date-pickers/desktop-time-picker-pt.json index 075715966429..cbe04d5cd79e 100644 --- a/docs/translations/api-docs/date-pickers/desktop-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/desktop-time-picker-pt.json @@ -32,10 +32,10 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showToolbar": "If true, show the toolbar even in desktop mode.", @@ -43,7 +43,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-time-picker-zh.json b/docs/translations/api-docs/date-pickers/desktop-time-picker-zh.json index 075715966429..cbe04d5cd79e 100644 --- a/docs/translations/api-docs/date-pickers/desktop-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/desktop-time-picker-zh.json @@ -32,10 +32,10 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showToolbar": "If true, show the toolbar even in desktop mode.", @@ -43,7 +43,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/desktop-time-picker.json b/docs/translations/api-docs/date-pickers/desktop-time-picker.json index 075715966429..cbe04d5cd79e 100644 --- a/docs/translations/api-docs/date-pickers/desktop-time-picker.json +++ b/docs/translations/api-docs/date-pickers/desktop-time-picker.json @@ -32,10 +32,10 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showToolbar": "If true, show the toolbar even in desktop mode.", @@ -43,7 +43,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/mobile-date-picker-pt.json b/docs/translations/api-docs/date-pickers/mobile-date-picker-pt.json index 9f4a8ea336a7..9f52c9ff16c5 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-picker-pt.json @@ -10,7 +10,7 @@ "components": "The components used for each slot. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -41,8 +41,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-picker-zh.json b/docs/translations/api-docs/date-pickers/mobile-date-picker-zh.json index 9f4a8ea336a7..9f52c9ff16c5 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-picker-zh.json @@ -10,7 +10,7 @@ "components": "The components used for each slot. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -41,8 +41,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-picker.json index 9f4a8ea336a7..9f52c9ff16c5 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-picker.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-picker.json @@ -10,7 +10,7 @@ "components": "The components used for each slot. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -41,8 +41,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json index a68443e07ef4..deedb920aae1 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-pt.json @@ -11,7 +11,7 @@ "components": "The components used for each slot. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableAutoMonthSwitching": "If true, after selecting start date calendar will not automatically switch to the month of end date.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", @@ -43,7 +43,7 @@ "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json index a68443e07ef4..deedb920aae1 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-range-picker-zh.json @@ -11,7 +11,7 @@ "components": "The components used for each slot. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableAutoMonthSwitching": "If true, after selecting start date calendar will not automatically switch to the month of end date.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", @@ -43,7 +43,7 @@ "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json index a68443e07ef4..deedb920aae1 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-range-picker.json @@ -11,7 +11,7 @@ "components": "The components used for each slot. Either a string to use a HTML element or a component.", "componentsProps": "The props used for each slot inside.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableAutoMonthSwitching": "If true, after selecting start date calendar will not automatically switch to the month of end date.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", @@ -43,7 +43,7 @@ "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-time-picker-pt.json b/docs/translations/api-docs/date-pickers/mobile-date-time-picker-pt.json index 61bc06d48a21..adae0b1a582d 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-time-picker-pt.json @@ -13,7 +13,7 @@ "componentsProps": "The props used for each slot inside.", "dateRangeIcon": "Date tab icon.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -52,8 +52,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-time-picker-zh.json b/docs/translations/api-docs/date-pickers/mobile-date-time-picker-zh.json index 61bc06d48a21..adae0b1a582d 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-time-picker-zh.json @@ -13,7 +13,7 @@ "componentsProps": "The props used for each slot inside.", "dateRangeIcon": "Date tab icon.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -52,8 +52,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-date-time-picker.json b/docs/translations/api-docs/date-pickers/mobile-date-time-picker.json index 61bc06d48a21..adae0b1a582d 100644 --- a/docs/translations/api-docs/date-pickers/mobile-date-time-picker.json +++ b/docs/translations/api-docs/date-pickers/mobile-date-time-picker.json @@ -13,7 +13,7 @@ "componentsProps": "The props used for each slot inside.", "dateRangeIcon": "Date tab icon.", "defaultCalendarMonth": "Default calendar month displayed when value={null}.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableHighlightToday": "If true, todays date is rendering without highlighting with circle.", @@ -52,8 +52,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/mobile-time-picker-pt.json b/docs/translations/api-docs/date-pickers/mobile-time-picker-pt.json index 99bf2ec0261d..f5b674e40680 100644 --- a/docs/translations/api-docs/date-pickers/mobile-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/mobile-time-picker-pt.json @@ -9,7 +9,7 @@ "clearable": "If true, it shows the clear action in the picker dialog.", "clearText": "Clear text message.", "components": "The components used for each slot. Either a string to use a HTML element or a component.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.", @@ -36,7 +36,7 @@ "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showTodayButton": "If true, the today button is displayed. Note that showClearButton has a higher priority.", diff --git a/docs/translations/api-docs/date-pickers/mobile-time-picker-zh.json b/docs/translations/api-docs/date-pickers/mobile-time-picker-zh.json index 99bf2ec0261d..f5b674e40680 100644 --- a/docs/translations/api-docs/date-pickers/mobile-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/mobile-time-picker-zh.json @@ -9,7 +9,7 @@ "clearable": "If true, it shows the clear action in the picker dialog.", "clearText": "Clear text message.", "components": "The components used for each slot. Either a string to use a HTML element or a component.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.", @@ -36,7 +36,7 @@ "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showTodayButton": "If true, the today button is displayed. Note that showClearButton has a higher priority.", diff --git a/docs/translations/api-docs/date-pickers/mobile-time-picker.json b/docs/translations/api-docs/date-pickers/mobile-time-picker.json index 99bf2ec0261d..f5b674e40680 100644 --- a/docs/translations/api-docs/date-pickers/mobile-time-picker.json +++ b/docs/translations/api-docs/date-pickers/mobile-time-picker.json @@ -9,7 +9,7 @@ "clearable": "If true, it shows the clear action in the picker dialog.", "clearText": "Clear text message.", "components": "The components used for each slot. Either a string to use a HTML element or a component.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.", @@ -36,7 +36,7 @@ "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showTodayButton": "If true, the today button is displayed. Note that showClearButton has a higher priority.", diff --git a/docs/translations/api-docs/date-pickers/static-date-picker-pt.json b/docs/translations/api-docs/date-pickers/static-date-picker-pt.json index 83b94689bd5b..b99d2cd0696c 100644 --- a/docs/translations/api-docs/date-pickers/static-date-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/static-date-picker-pt.json @@ -37,8 +37,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-picker-zh.json b/docs/translations/api-docs/date-pickers/static-date-picker-zh.json index 83b94689bd5b..b99d2cd0696c 100644 --- a/docs/translations/api-docs/date-pickers/static-date-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/static-date-picker-zh.json @@ -37,8 +37,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-picker.json b/docs/translations/api-docs/date-pickers/static-date-picker.json index 83b94689bd5b..b99d2cd0696c 100644 --- a/docs/translations/api-docs/date-pickers/static-date-picker.json +++ b/docs/translations/api-docs/date-pickers/static-date-picker.json @@ -37,8 +37,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json b/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json index ef47765dc9a0..4e4cbcba1a87 100644 --- a/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/static-date-range-picker-pt.json @@ -39,7 +39,7 @@ "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json b/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json index ef47765dc9a0..4e4cbcba1a87 100644 --- a/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/static-date-range-picker-zh.json @@ -39,7 +39,7 @@ "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-range-picker.json b/docs/translations/api-docs/date-pickers/static-date-range-picker.json index ef47765dc9a0..4e4cbcba1a87 100644 --- a/docs/translations/api-docs/date-pickers/static-date-range-picker.json +++ b/docs/translations/api-docs/date-pickers/static-date-range-picker.json @@ -39,7 +39,7 @@ "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", "renderDay": "Custom renderer for <DateRangePicker /> days. @DateIOType

                                                  Signature:
                                                  function(day: TDate, dateRangePickerDayProps: DateRangePickerDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  dateRangePickerDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The startProps and endProps arguments of this render prop contains props of TextField, that you need to forward to the range start/end inputs respectively. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(startProps: MuiTextFieldProps, endProps: MuiTextFieldProps) => React.ReactElement
                                                  startProps: Props that you need to forward to the range start input.
                                                  endProps: Props that you need to forward to the range end input.
                                                  returns (React.ReactElement): The range input to render.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-time-picker-pt.json b/docs/translations/api-docs/date-pickers/static-date-time-picker-pt.json index 319c1a5effaf..c381446b0ab9 100644 --- a/docs/translations/api-docs/date-pickers/static-date-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/static-date-time-picker-pt.json @@ -48,8 +48,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-time-picker-zh.json b/docs/translations/api-docs/date-pickers/static-date-time-picker-zh.json index 319c1a5effaf..c381446b0ab9 100644 --- a/docs/translations/api-docs/date-pickers/static-date-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/static-date-time-picker-zh.json @@ -48,8 +48,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-date-time-picker.json b/docs/translations/api-docs/date-pickers/static-date-time-picker.json index 319c1a5effaf..c381446b0ab9 100644 --- a/docs/translations/api-docs/date-pickers/static-date-time-picker.json +++ b/docs/translations/api-docs/date-pickers/static-date-time-picker.json @@ -48,8 +48,8 @@ "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", "reduceAnimations": "Disable heavy animations.", - "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderDay": "Custom renderer for day. Check the PickersDay component.

                                                  Signature:
                                                  function(day: TDate, selectedDates: Array<TDate | null>, pickersDayProps: PickersDayProps<TDate>) => JSX.Element
                                                  day: The day to render.
                                                  selectedDates: The dates currently selected.
                                                  pickersDayProps: The props of the day to render.
                                                  returns (JSX.Element): The element representing the day.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "renderLoading": "Component displaying when passed loading true.

                                                  Signature:
                                                  function() => React.ReactNode

                                                  returns (React.ReactNode): The node to render when loading.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "rightArrowButtonText": "Right arrow icon aria-label text.", diff --git a/docs/translations/api-docs/date-pickers/static-time-picker-pt.json b/docs/translations/api-docs/date-pickers/static-time-picker-pt.json index 25bcfc87c351..713cbf61d099 100644 --- a/docs/translations/api-docs/date-pickers/static-time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/static-time-picker-pt.json @@ -32,7 +32,7 @@ "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showToolbar": "If true, show the toolbar even in desktop mode.", diff --git a/docs/translations/api-docs/date-pickers/static-time-picker-zh.json b/docs/translations/api-docs/date-pickers/static-time-picker-zh.json index 25bcfc87c351..713cbf61d099 100644 --- a/docs/translations/api-docs/date-pickers/static-time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/static-time-picker-zh.json @@ -32,7 +32,7 @@ "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showToolbar": "If true, show the toolbar even in desktop mode.", diff --git a/docs/translations/api-docs/date-pickers/static-time-picker.json b/docs/translations/api-docs/date-pickers/static-time-picker.json index 25bcfc87c351..713cbf61d099 100644 --- a/docs/translations/api-docs/date-pickers/static-time-picker.json +++ b/docs/translations/api-docs/date-pickers/static-time-picker.json @@ -32,7 +32,7 @@ "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showToolbar": "If true, show the toolbar even in desktop mode.", diff --git a/docs/translations/api-docs/date-pickers/time-picker-pt.json b/docs/translations/api-docs/date-pickers/time-picker-pt.json index 9e46776f0f8e..e602f65bb0d5 100644 --- a/docs/translations/api-docs/date-pickers/time-picker-pt.json +++ b/docs/translations/api-docs/date-pickers/time-picker-pt.json @@ -10,7 +10,7 @@ "clearText": "Clear text message.", "components": "The components used for each slot. Either a string to use a HTML element or a component.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.", @@ -36,10 +36,10 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showTodayButton": "If true, the today button is displayed. Note that showClearButton has a higher priority.", @@ -49,7 +49,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/time-picker-zh.json b/docs/translations/api-docs/date-pickers/time-picker-zh.json index 9e46776f0f8e..e602f65bb0d5 100644 --- a/docs/translations/api-docs/date-pickers/time-picker-zh.json +++ b/docs/translations/api-docs/date-pickers/time-picker-zh.json @@ -10,7 +10,7 @@ "clearText": "Clear text message.", "components": "The components used for each slot. Either a string to use a HTML element or a component.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.", @@ -36,10 +36,10 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showTodayButton": "If true, the today button is displayed. Note that showClearButton has a higher priority.", @@ -49,7 +49,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docs/translations/api-docs/date-pickers/time-picker.json b/docs/translations/api-docs/date-pickers/time-picker.json index 9e46776f0f8e..e602f65bb0d5 100644 --- a/docs/translations/api-docs/date-pickers/time-picker.json +++ b/docs/translations/api-docs/date-pickers/time-picker.json @@ -10,7 +10,7 @@ "clearText": "Clear text message.", "components": "The components used for each slot. Either a string to use a HTML element or a component.", "desktopModeMediaQuery": "CSS media query when Mobile mode will be changed to Desktop.", - "DialogProps": "Props applied to the Dialog element.", + "DialogProps": "Props applied to the Dialog element.", "disableCloseOnSelect": "If true the popup or dialog will immediately close after submitting full date.", "disabled": "If true, the picker and text field are disabled.", "disableIgnoringDatePartForTimeValidation": "Do not ignore date part when validating min/max time.", @@ -36,10 +36,10 @@ "OpenPickerButtonProps": "Props to pass to keyboard adornment button.", "openTo": "First view to show.", "orientation": "Force rendering in particular orientation.", - "PaperProps": "Paper props passed down to Paper component.", - "PopperProps": "Popper props passed down to Popper component.", + "PaperProps": "Paper props passed down to Paper component.", + "PopperProps": "Popper props passed down to Popper component.", "readOnly": "Make picker read only.", - "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", + "renderInput": "The renderInput prop allows you to customize the rendered input. The props argument of this render prop contains props of TextField that you need to forward. Pay specific attention to the ref and inputProps keys.

                                                  Signature:
                                                  function(props: MuiTextFieldPropsType) => React.ReactNode
                                                  props: The props of the input.
                                                  returns (React.ReactNode): The node to render as the input.", "rifmFormatter": "Custom formatter to be passed into Rifm component.

                                                  Signature:
                                                  function(str: string) => string
                                                  str: The un-formatted string.
                                                  returns (string): The formatted string.", "shouldDisableTime": "Dynamically check if time is disabled or not. If returns false appropriate time point will ot be acceptable.

                                                  Signature:
                                                  function(timeValue: number, clockType: ClockPickerView) => boolean
                                                  timeValue: The value to check.
                                                  clockType: The clock type of the timeValue.
                                                  returns (boolean): Returns true if the time should be disabled", "showTodayButton": "If true, the today button is displayed. Note that showClearButton has a higher priority.", @@ -49,7 +49,7 @@ "toolbarFormat": "Date format, that is displaying in toolbar.", "toolbarPlaceholder": "Mobile picker date value placeholder, displaying if value === null.", "toolbarTitle": "Mobile picker title, displaying in the toolbar.", - "TransitionComponent": "Custom component for popper Transition.", + "TransitionComponent": "Custom component for popper Transition.", "value": "The value of the picker.", "views": "Array of views to show." }, diff --git a/docsTech/README.md b/docsTech/README.md index c221cd13c4bb..6018c5a293c7 100644 --- a/docsTech/README.md +++ b/docsTech/README.md @@ -6,7 +6,7 @@

                                                  MUI X DataGrid overview

                                                  -Welcome in the documentation for contributors. If you want to use DataGrid components for your project, the [documention for developpers](https://mui.com/components/data-grid/getting-started/) is more appropriate. +Welcome in the documentation for contributors. If you want to use DataGrid components for your project, the [documention for developpers](https://mui.com/x/react-data-grid/getting-started/) is more appropriate. Here we will discuss how the code is structured, to simplify codebase navigation, and onboard new contributors. ## Where is the code? @@ -23,7 +23,7 @@ In each package, the most used folders are: - `hooks/utils` defines logics for contributors: manipulating the state, managing events, ... - `hooks/features` defines logics for end-users: selection, filtering, editing, ... - `DataGrid[Pro]/useDataGrid[Pro]Component.tsx` is the file in which all the hooks are added to the grid -- `colDef` contains the default values for each [column type](https://mui.com/components/data-grid/columns/#column-types): rendering cell, filter operators, sorting method, ... +- `colDef` contains the default values for each [column type](https://mui.com/x/react-data-grid/columns/#column-types): rendering cell, filter operators, sorting method, ... - `models` define the typescript interfaces of the gird ## How does it work? @@ -33,7 +33,7 @@ In each package, the most used folders are: ### Accessing state -The react components can [access the state](https://mui.com/components/data-grid/state/#access-the-state) with either selectors or getter methods. +The react components can [access the state](https://mui.com/x/react-data-grid/state/#access-the-state) with either selectors or getter methods. Here is an example. ```js @@ -61,7 +61,7 @@ Each of them defines an event handler responsible for modifying their sub-state. useGridApiEventHandler(apiRef, GridEvents.cellKeyDown, handleCellKeyDown); ``` -The other interest of events is that developers can listen to them by [subscribing to the event](https://mui.com/components/data-grid/events/#subscribing-to-events) or by providing a `on` prop such as `onEditCellPropsChange`. +The other interest of events is that developers can listen to them by [subscribing to the event](https://mui.com/x/react-data-grid/events/#subscribing-to-events) or by providing a `on` prop such as `onEditCellPropsChange`. Notice that all the events do not have an associated prop `on` ## Specific features diff --git a/docsTech/filtering.md b/docsTech/filtering.md index 88f6807c3b75..29f295c29c98 100644 --- a/docsTech/filtering.md +++ b/docsTech/filtering.md @@ -4,7 +4,7 @@ ### Data -First, let's see how the filtering is saved in the state. Here are the types of the [filter model](https://mui.com/api/data-grid/grid-filter-model/). It is made of a `linkOperator`, and a list of [items](https://mui.com/api/data-grid/grid-filter-item/). Each item corresponds to a line in the filtering panel. Each item corresponds to a line in the filter panel. +First, let's see how the filtering is saved in the state. Here are the types of the [filter model](https://mui.com/x/api/data-grid/grid-filter-model/). It is made of a `linkOperator`, and a list of [items](https://mui.com/x/api/data-grid/grid-filter-item/). Each item corresponds to a line in the filtering panel. Each item corresponds to a line in the filter panel. ```ts interface GridFilterModel { diff --git a/package.json b/package.json index d0dd780df7b6..5ab34c8865a7 100644 --- a/package.json +++ b/package.json @@ -100,8 +100,8 @@ "@types/requestidlecallback": "^0.3.4", "@types/sinon": "^10.0.11", "@types/yargs": "^17.0.10", - "@typescript-eslint/eslint-plugin": "^5.16.0", - "@typescript-eslint/parser": "^5.16.0", + "@typescript-eslint/eslint-plugin": "^5.18.0", + "@typescript-eslint/parser": "^5.18.0", "argos-cli": "^0.3.3", "babel-loader": "^8.2.4", "babel-plugin-istanbul": "^6.1.1", @@ -115,7 +115,7 @@ "chai": "^4.3.6", "chai-dom": "^1.11.0", "compression-webpack-plugin": "^9.2.0", - "concurrently": "^7.0.0", + "concurrently": "^7.1.0", "cross-env": "^7.0.3", "danger": "^11.0.2", "enzyme": "^3.11.0", @@ -125,12 +125,12 @@ "eslint-import-resolver-webpack": "^0.13.2", "eslint-plugin-filenames": "^1.3.2", "eslint-plugin-import": "^2.25.4", - "eslint-plugin-jsdoc": "^38.1.3", + "eslint-plugin-jsdoc": "^38.1.6", "eslint-plugin-jsx-a11y": "^6.5.1", "eslint-plugin-mocha": "^9.0.0", "eslint-plugin-prettier": "^4.0.0", "eslint-plugin-react": "^7.29.4", - "eslint-plugin-react-hooks": "^4.3.0", + "eslint-plugin-react-hooks": "^4.4.0", "format-util": "^1.0.5", "glob-gitignore": "^1.0.14", "jsdom": "^19.0.0", @@ -148,14 +148,14 @@ "mocha": "^9.2.2", "nyc": "^15.1.0", "playwright": "^1.20.1", - "prettier": "^2.6.1", + "prettier": "^2.6.2", "react": "^17.0.2", "react-dom": "^17.0.2", "serve": "^13.0.2", "sinon": "^13.0.1", "stream-browserify": "^3.0.0", "typescript": "^4.6.3", - "webpack": "^5.70.0", + "webpack": "^5.71.0", "webpack-cli": "^4.9.2", "yargs": "^17.4.0", "yarn-deduplicate": "^3.1.0" diff --git a/packages/eslint-plugin-material-ui/package.json b/packages/eslint-plugin-material-ui/package.json index 924eebd6487f..51a8f7752d2a 100644 --- a/packages/eslint-plugin-material-ui/package.json +++ b/packages/eslint-plugin-material-ui/package.json @@ -6,8 +6,8 @@ "main": "src/index.js", "devDependencies": { "@types/eslint": "^8.4.1", - "@typescript-eslint/experimental-utils": "^5.16.0", - "@typescript-eslint/parser": "^5.16.0" + "@typescript-eslint/experimental-utils": "^5.18.0", + "@typescript-eslint/parser": "^5.18.0" }, "scripts": { "test": "cd ../../ && cross-env NODE_ENV=test mocha 'packages/eslint-plugin-material-ui/**/*.test.js' --timeout 3000" diff --git a/packages/grid/x-data-grid-generator/package.json b/packages/grid/x-data-grid-generator/package.json index b212d95a7779..b9d3f512f49d 100644 --- a/packages/grid/x-data-grid-generator/package.json +++ b/packages/grid/x-data-grid-generator/package.json @@ -8,7 +8,7 @@ "bugs": { "url": "https://github.com/mui/mui-x/issues" }, - "homepage": "https://mui.com/components/data-grid/", + "homepage": "https://mui.com/x/react-data-grid/", "sideEffects": false, "publishConfig": { "access": "public" diff --git a/packages/grid/x-data-grid-pro/README.md b/packages/grid/x-data-grid-pro/README.md index e6e5c3e54476..7b11f1a5f9fc 100644 --- a/packages/grid/x-data-grid-pro/README.md +++ b/packages/grid/x-data-grid-pro/README.md @@ -26,4 +26,4 @@ This component has three peer dependencies that you will need to install as well ## Documentation -[The documentation](https://mui.com/components/data-grid/) +[The documentation](https://mui.com/x/react-data-grid/) diff --git a/packages/grid/x-data-grid-pro/package.json b/packages/grid/x-data-grid-pro/package.json index 19d25dd14a74..48f82ea50923 100644 --- a/packages/grid/x-data-grid-pro/package.json +++ b/packages/grid/x-data-grid-pro/package.json @@ -4,11 +4,11 @@ "description": "The commercial edition of the data grid component (MUI X).", "author": "MUI Team", "main": "src/index.ts", - "license": "SEE LICENSE IN LICENSE.txt", + "license": "SEE LICENSE IN LICENSE", "bugs": { "url": "https://github.com/mui/mui-x/issues" }, - "homepage": "https://mui.com/components/data-grid/", + "homepage": "https://mui.com/x/react-data-grid/", "sideEffects": false, "publishConfig": { "access": "public" diff --git a/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx b/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx index ba043ece699a..7e9fb9539c97 100644 --- a/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx +++ b/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx @@ -560,7 +560,7 @@ DataGridProRaw.propTypes = { * @param {GridEditCellPropsParams} params With all properties from [[GridEditCellPropsParams]]. * @param {MuiEvent} event The event that caused this prop to be called. * @param {GridCallbackDetails} details Additional details for this callback. - * @deprecated use `preProcessEditCellProps` from the [`GridColDef`](/api/data-grid/grid-col-def/) + * @deprecated use `preProcessEditCellProps` from the [`GridColDef`](/x/api/data-grid/grid-col-def/) */ onEditCellPropsChange: PropTypes.func, /** diff --git a/packages/grid/x-data-grid/README.md b/packages/grid/x-data-grid/README.md index b68ff7d8e68d..4379c4a646b5 100644 --- a/packages/grid/x-data-grid/README.md +++ b/packages/grid/x-data-grid/README.md @@ -26,4 +26,4 @@ This component has three peer dependencies that you will need to install as well ## Documentation -[The documentation](https://mui.com/components/data-grid/) +[The documentation](https://mui.com/x/react-data-grid/) diff --git a/packages/grid/x-data-grid/package.json b/packages/grid/x-data-grid/package.json index 72595e8a561e..21d784fede95 100644 --- a/packages/grid/x-data-grid/package.json +++ b/packages/grid/x-data-grid/package.json @@ -8,7 +8,7 @@ "bugs": { "url": "https://github.com/mui/mui-x/issues" }, - "homepage": "https://mui.com/components/data-grid/", + "homepage": "https://mui.com/x/react-data-grid/", "sideEffects": false, "funding": { "type": "opencollective", diff --git a/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx b/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx index 42a7cfa64f31..3a11ad4859e9 100644 --- a/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx +++ b/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx @@ -422,7 +422,7 @@ DataGridRaw.propTypes = { * @param {GridEditCellPropsParams} params With all properties from [[GridEditCellPropsParams]]. * @param {MuiEvent} event The event that caused this prop to be called. * @param {GridCallbackDetails} details Additional details for this callback. - * @deprecated use `preProcessEditCellProps` from the [`GridColDef`](/api/data-grid/grid-col-def/) + * @deprecated use `preProcessEditCellProps` from the [`GridColDef`](/x/api/data-grid/grid-col-def/) */ onEditCellPropsChange: PropTypes.func, /** diff --git a/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScroller.tsx b/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScroller.tsx index 0ccfcae598e3..0c346833a93a 100644 --- a/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScroller.tsx +++ b/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScroller.tsx @@ -24,6 +24,8 @@ const VirtualScrollerRoot = styled('div', { overridesResolver: (props, styles) => styles.virtualScroller, })({ overflow: 'auto', + // See https://github.com/mui/mui-x/issues/4360 + position: 'relative', '@media print': { overflow: 'hidden', }, diff --git a/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScrollerContent.tsx b/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScrollerContent.tsx index 677137e53fae..8eea840d0eaf 100644 --- a/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScrollerContent.tsx +++ b/packages/grid/x-data-grid/src/components/virtualization/GridVirtualScrollerContent.tsx @@ -22,9 +22,7 @@ const VirtualScrollerContentRoot = styled('div', { name: 'MuiDataGrid', slot: 'VirtualScrollerContent', overridesResolver: (props, styles) => styles.virtualScrollerContent, -})({ - position: 'relative', -}); +})({}); const GridVirtualScrollerContent = React.forwardRef< HTMLDivElement, diff --git a/packages/grid/x-data-grid/src/hooks/features/dimensions/useGridDimensions.ts b/packages/grid/x-data-grid/src/hooks/features/dimensions/useGridDimensions.ts index 40b687a28c8f..49aab4afbbd1 100644 --- a/packages/grid/x-data-grid/src/hooks/features/dimensions/useGridDimensions.ts +++ b/packages/grid/x-data-grid/src/hooks/features/dimensions/useGridDimensions.ts @@ -207,7 +207,7 @@ export function useGridDimensions( 'The grid displays with a height of 0px.', '', 'You can find a solution in the docs:', - 'https://mui.com/components/data-grid/layout/', + 'https://mui.com/x/react-data-grid/layout/', ].join('\n'), ); warningShown.current = true; @@ -220,7 +220,7 @@ export function useGridDimensions( 'The grid displays with a width of 0px.', '', 'You can find a solution in the docs:', - 'https://mui.com/components/data-grid/layout/', + 'https://mui.com/x/react-data-grid/layout/', ].join('\n'), ); warningShown.current = true; diff --git a/packages/grid/x-data-grid/src/models/events/gridEvents.ts b/packages/grid/x-data-grid/src/models/events/gridEvents.ts index c5440676a645..7607e70fe7d0 100644 --- a/packages/grid/x-data-grid/src/models/events/gridEvents.ts +++ b/packages/grid/x-data-grid/src/models/events/gridEvents.ts @@ -94,7 +94,7 @@ enum GridEvents { */ rowEditCommit = 'rowEditCommit', /** - * Fired when a [navigation key](/components/data-grid/accessibility#keyboard-navigation) is pressed in a cell. + * Fired when a [navigation key](/x/react-data-grid/accessibility#keyboard-navigation) is pressed in a cell. * @ignore - do not document. */ cellNavigationKeyDown = 'cellNavigationKeyDown', @@ -130,7 +130,7 @@ enum GridEvents { */ columnHeaderFocus = 'columnHeaderFocus', /** - * Fired when a [navigation key](/components/data-grid/accessibility#keyboard-navigation) is pressed in a column header. + * Fired when a [navigation key](/x/react-data-grid/accessibility#keyboard-navigation) is pressed in a column header. * @ignore - do not document. */ columnHeaderNavigationKeyDown = 'columnHeaderNavigationKeyDown', diff --git a/packages/grid/x-data-grid/src/models/props/DataGridProps.ts b/packages/grid/x-data-grid/src/models/props/DataGridProps.ts index eb62d3747ee5..77d8bc49cc21 100644 --- a/packages/grid/x-data-grid/src/models/props/DataGridProps.ts +++ b/packages/grid/x-data-grid/src/models/props/DataGridProps.ts @@ -404,7 +404,7 @@ export interface DataGridPropsWithoutDefaultValue} event The event that caused this prop to be called. * @param {GridCallbackDetails} details Additional details for this callback. - * @deprecated use `preProcessEditCellProps` from the [`GridColDef`](/api/data-grid/grid-col-def/) + * @deprecated use `preProcessEditCellProps` from the [`GridColDef`](/x/api/data-grid/grid-col-def/) */ onEditCellPropsChange?: GridEventListener; /** diff --git a/packages/storybook/package.json b/packages/storybook/package.json index 954aa4920c8e..7e9fdd2c34bf 100644 --- a/packages/storybook/package.json +++ b/packages/storybook/package.json @@ -27,7 +27,7 @@ "react": "^17.0.2", "react-is": "^17.0.2", "rxjs": "^7.5.5", - "webpack": "^5.70.0" + "webpack": "^5.71.0" }, "devDependencies": { "@babel/core": "^7.17.8", diff --git a/packages/x-date-pickers-pro/README.md b/packages/x-date-pickers-pro/README.md index d4d2333a1269..a3574cdfd244 100644 --- a/packages/x-date-pickers-pro/README.md +++ b/packages/x-date-pickers-pro/README.md @@ -26,4 +26,4 @@ This component has three peer dependencies that you will need to install as well ## Documentation -[The documentation](https://mui.com/components/x/react-date-pickers/date-picker/) +[The documentation](https://mui.com/x/react-date-pickers/date-picker/) diff --git a/packages/x-date-pickers-pro/package.json b/packages/x-date-pickers-pro/package.json index b962a39409dd..f5bf8d7c79f4 100644 --- a/packages/x-date-pickers-pro/package.json +++ b/packages/x-date-pickers-pro/package.json @@ -6,9 +6,9 @@ "main": "./src/index.js", "license": "SEE LICENSE IN LICENSE", "bugs": { - "url": "https://github.com/mui-org/material-ui-x/issues" + "url": "https://github.com/mui/mui-x/issues" }, - "homepage": "https://mui.com/components/x/react-date-pickers/date-picker/", + "homepage": "https://mui.com/x/react-date-pickers/date-picker/", "sideEffects": false, "publishConfig": { "access": "public" diff --git a/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePicker.tsx b/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePicker.tsx index f7847c49c610..7d4937c4207a 100644 --- a/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePicker.tsx +++ b/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePicker.tsx @@ -93,11 +93,11 @@ type DateRangePickerComponent = (( * * Demos: * - * - [Date Range Picker](https://mui.com/components/x/react-date-pickers/date-range-picker/) + * - [Date Range Picker](https://mui.com/x/react-date-pickers/date-range-picker/) * * API: * - * - [DateRangePicker API](https://mui.com/api/date-range-picker/) + * - [DateRangePicker API](https://mui.com/x/api/date-pickers/date-range-picker/) */ export const DateRangePicker = React.forwardRef(function DateRangePicker( inProps: DateRangePickerProps, @@ -245,7 +245,7 @@ DateRangePicker.propTypes = { */ desktopModeMediaQuery: PropTypes.string, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -411,11 +411,11 @@ DateRangePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -438,7 +438,7 @@ DateRangePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api), + * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props), * that you need to forward to the range start/end inputs respectively. * Pay specific attention to the `ref` and `inputProps` keys. * @example @@ -530,7 +530,7 @@ DateRangePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePickerInput.tsx b/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePickerInput.tsx index fffdb726de42..2f2097ffd756 100644 --- a/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePickerInput.tsx +++ b/packages/x-date-pickers-pro/src/DateRangePicker/DateRangePickerInput.tsx @@ -29,7 +29,7 @@ export interface ExportedDateRangePickerInputProps extends Omit, DateRange>, 'renderInput'> { /** * The `renderInput` prop allows you to customize the rendered input. - * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api), + * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props), * that you need to forward to the range start/end inputs respectively. * Pay specific attention to the `ref` and `inputProps` keys. * @example diff --git a/packages/x-date-pickers-pro/src/DateRangePickerDay/DateRangePickerDay.tsx b/packages/x-date-pickers-pro/src/DateRangePickerDay/DateRangePickerDay.tsx index baf27dd17b13..9734af3da819 100644 --- a/packages/x-date-pickers-pro/src/DateRangePickerDay/DateRangePickerDay.tsx +++ b/packages/x-date-pickers-pro/src/DateRangePickerDay/DateRangePickerDay.tsx @@ -375,11 +375,11 @@ const propsAreEqual = ( * * Demos: * - * - [Date Range Picker](https://mui.com/components/x/react-date-pickers/date-range-picker/) + * - [Date Range Picker](https://mui.com/x/react-date-pickers/date-range-picker/) * * API: * - * - [DateRangePickerDay API](https://mui.com/api/date-range-picker-day/) + * - [DateRangePickerDay API](https://mui.com/x/api/date-pickers/date-range-picker-day/) */ export const DateRangePickerDay = React.memo( DateRangePickerDayRaw, diff --git a/packages/x-date-pickers-pro/src/DesktopDateRangePicker/DesktopDateRangePicker.tsx b/packages/x-date-pickers-pro/src/DesktopDateRangePicker/DesktopDateRangePicker.tsx index 460b9808dc1f..a8253ed1bd4a 100644 --- a/packages/x-date-pickers-pro/src/DesktopDateRangePicker/DesktopDateRangePicker.tsx +++ b/packages/x-date-pickers-pro/src/DesktopDateRangePicker/DesktopDateRangePicker.tsx @@ -98,11 +98,11 @@ type DesktopDateRangePickerComponent = (( * * Demos: * - * - [Date Range Picker](https://mui.com/components/x/react-date-pickers/date-range-picker/) + * - [Date Range Picker](https://mui.com/x/react-date-pickers/date-range-picker/) * * API: * - * - [DesktopDateRangePicker API](https://mui.com/api/desktop-date-range-picker/) + * - [DesktopDateRangePicker API](https://mui.com/x/api/date-pickers/desktop-date-range-picker/) */ export const DesktopDateRangePicker = React.forwardRef(function DesktopDateRangePicker( inProps: DesktopDateRangePickerProps, @@ -398,11 +398,11 @@ DesktopDateRangePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -425,7 +425,7 @@ DesktopDateRangePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api), + * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props), * that you need to forward to the range start/end inputs respectively. * Pay specific attention to the `ref` and `inputProps` keys. * @example @@ -507,7 +507,7 @@ DesktopDateRangePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers-pro/src/MobileDateRangePicker/MobileDateRangePicker.tsx b/packages/x-date-pickers-pro/src/MobileDateRangePicker/MobileDateRangePicker.tsx index fdeb165d87e2..4b55ab064c3d 100644 --- a/packages/x-date-pickers-pro/src/MobileDateRangePicker/MobileDateRangePicker.tsx +++ b/packages/x-date-pickers-pro/src/MobileDateRangePicker/MobileDateRangePicker.tsx @@ -98,11 +98,11 @@ type MobileDateRangePickerComponent = (( * * Demos: * - * - [Date Range Picker](https://mui.com/components/x/react-date-pickers/date-range-picker/) + * - [Date Range Picker](https://mui.com/x/react-date-pickers/date-range-picker/) * * API: * - * - [MobileDateRangePicker API](https://mui.com/api/mobile-date-range-picker/) + * - [MobileDateRangePicker API](https://mui.com/x/api/date-pickers/mobile-date-range-picker/) */ export const MobileDateRangePicker = React.forwardRef(function MobileDateRangePicker( inProps: MobileDateRangePickerProps, @@ -243,7 +243,7 @@ MobileDateRangePicker.propTypes = { */ defaultCalendarMonth: PropTypes.any, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -428,7 +428,7 @@ MobileDateRangePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api), + * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props), * that you need to forward to the range start/end inputs respectively. * Pay specific attention to the `ref` and `inputProps` keys. * @example diff --git a/packages/x-date-pickers-pro/src/StaticDateRangePicker/StaticDateRangePicker.tsx b/packages/x-date-pickers-pro/src/StaticDateRangePicker/StaticDateRangePicker.tsx index 648ca9be2ad3..c8cd247a1a39 100644 --- a/packages/x-date-pickers-pro/src/StaticDateRangePicker/StaticDateRangePicker.tsx +++ b/packages/x-date-pickers-pro/src/StaticDateRangePicker/StaticDateRangePicker.tsx @@ -95,11 +95,11 @@ type StaticDateRangePickerComponent = (( * * Demos: * - * - [Date Range Picker](https://mui.com/components/x/react-date-pickers/date-range-picker/) + * - [Date Range Picker](https://mui.com/x/react-date-pickers/date-range-picker/) * * API: * - * - [StaticDateRangePicker API](https://mui.com/api/static-date-range-picker/) + * - [StaticDateRangePicker API](https://mui.com/x/api/date-pickers/static-date-range-picker/) */ export const StaticDateRangePicker = React.forwardRef(function StaticDateRangePicker( inProps: StaticDateRangePickerProps, @@ -399,7 +399,7 @@ StaticDateRangePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api), + * The `startProps` and `endProps` arguments of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props), * that you need to forward to the range start/end inputs respectively. * Pay specific attention to the `ref` and `inputProps` keys. * @example diff --git a/packages/x-date-pickers/README.md b/packages/x-date-pickers/README.md index d4d2333a1269..a3574cdfd244 100644 --- a/packages/x-date-pickers/README.md +++ b/packages/x-date-pickers/README.md @@ -26,4 +26,4 @@ This component has three peer dependencies that you will need to install as well ## Documentation -[The documentation](https://mui.com/components/x/react-date-pickers/date-picker/) +[The documentation](https://mui.com/x/react-date-pickers/date-picker/) diff --git a/packages/x-date-pickers/package.json b/packages/x-date-pickers/package.json index b66296568d48..b65629176d90 100644 --- a/packages/x-date-pickers/package.json +++ b/packages/x-date-pickers/package.json @@ -6,9 +6,9 @@ "main": "./src/index.js", "license": "MIT", "bugs": { - "url": "https://github.com/mui-org/material-ui-x/issues" + "url": "https://github.com/mui/mui-x/issues" }, - "homepage": "https://mui.com/components/x/react-date-pickers/date-picker/", + "homepage": "https://mui.com/x/react-date-pickers/date-picker/", "funding": { "type": "opencollective", "url": "https://opencollective.com/mui" diff --git a/packages/x-date-pickers/src/CalendarPicker/CalendarPicker.tsx b/packages/x-date-pickers/src/CalendarPicker/CalendarPicker.tsx index 2e3c9c3ec304..4390c1c33a6a 100644 --- a/packages/x-date-pickers/src/CalendarPicker/CalendarPicker.tsx +++ b/packages/x-date-pickers/src/CalendarPicker/CalendarPicker.tsx @@ -152,11 +152,11 @@ type CalendarPickerComponent = (( * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * * API: * - * - [CalendarPicker API](https://mui.com/api/calendar-picker/) + * - [CalendarPicker API](https://mui.com/x/api/date-pickers/calendar-picker/) */ const CalendarPicker = React.forwardRef(function CalendarPicker( inProps: CalendarPickerProps, @@ -430,7 +430,7 @@ CalendarPicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. diff --git a/packages/x-date-pickers/src/CalendarPicker/DayPicker.tsx b/packages/x-date-pickers/src/CalendarPicker/DayPicker.tsx index 0ab0c0d29307..5a6f6fe0df9e 100644 --- a/packages/x-date-pickers/src/CalendarPicker/DayPicker.tsx +++ b/packages/x-date-pickers/src/CalendarPicker/DayPicker.tsx @@ -29,7 +29,7 @@ export interface ExportedCalendarProps */ onChange: PickerOnChangeFn; /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. diff --git a/packages/x-date-pickers/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx b/packages/x-date-pickers/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx index b172382e8003..ea389b6ca909 100644 --- a/packages/x-date-pickers/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx +++ b/packages/x-date-pickers/src/CalendarPickerSkeleton/CalendarPickerSkeleton.tsx @@ -87,11 +87,11 @@ const monthMap = [ * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * * API: * - * - [CalendarPickerSkeleton API](https://mui.com/api/calendar-picker-skeleton/) + * - [CalendarPickerSkeleton API](https://mui.com/x/api/date-pickers/calendar-picker-skeleton/) */ function CalendarPickerSkeleton(props: CalendarPickerSkeletonProps) { const { className, ...other } = useThemeProps< diff --git a/packages/x-date-pickers/src/ClockPicker/ClockPicker.tsx b/packages/x-date-pickers/src/ClockPicker/ClockPicker.tsx index 148cbe69ab36..56e26b8eea51 100644 --- a/packages/x-date-pickers/src/ClockPicker/ClockPicker.tsx +++ b/packages/x-date-pickers/src/ClockPicker/ClockPicker.tsx @@ -200,7 +200,7 @@ type ClockPickerComponent = (( * * API: * - * - [ClockPicker API](https://mui.com/api/clock-picker/) + * - [ClockPicker API](https://mui.com/x/api/date-pickers/clock-picker/) */ export const ClockPicker = React.forwardRef(function ClockPicker( inProps: ClockPickerProps, diff --git a/packages/x-date-pickers/src/DatePicker/DatePicker.tsx b/packages/x-date-pickers/src/DatePicker/DatePicker.tsx index b4bcd688ee16..e0a041046822 100644 --- a/packages/x-date-pickers/src/DatePicker/DatePicker.tsx +++ b/packages/x-date-pickers/src/DatePicker/DatePicker.tsx @@ -24,12 +24,12 @@ type DatePickerComponent = (( * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * - [Pickers](https://mui.com/x/react-date-pickers/) * * API: * - * - [DatePicker API](https://mui.com/api/date-picker/) + * - [DatePicker API](https://mui.com/x/api/date-pickers/date-picker/) */ export const DatePicker = React.forwardRef(function DatePicker( inProps: DatePickerProps, @@ -134,7 +134,7 @@ DatePicker.propTypes = { */ desktopModeMediaQuery: PropTypes.string, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -296,11 +296,11 @@ DatePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -314,7 +314,7 @@ DatePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -323,7 +323,7 @@ DatePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } @@ -400,7 +400,7 @@ DatePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx b/packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx index a3b0834f1280..a61625b30d83 100644 --- a/packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx +++ b/packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx @@ -24,12 +24,12 @@ type DateTimePickerComponent = (( * * Demos: * - * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/) + * - [Date Time Picker](https://mui.com/x/react-date-pickers/date-time-picker/) * - [Pickers](https://mui.com/x/react-date-pickers/) * * API: * - * - [DateTimePicker API](https://mui.com/api/date-time-picker/) + * - [DateTimePicker API](https://mui.com/x/api/date-pickers/date-time-picker/) */ const DateTimePicker = React.forwardRef(function DateTimePicker( inProps: DateTimePickerProps, @@ -146,7 +146,7 @@ DateTimePicker.propTypes = { */ desktopModeMediaQuery: PropTypes.string, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -356,11 +356,11 @@ DateTimePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -374,7 +374,7 @@ DateTimePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -383,7 +383,7 @@ DateTimePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } @@ -472,7 +472,7 @@ DateTimePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers/src/DesktopDatePicker/DesktopDatePicker.tsx b/packages/x-date-pickers/src/DesktopDatePicker/DesktopDatePicker.tsx index 107fa5428f0c..64cc032c7609 100644 --- a/packages/x-date-pickers/src/DesktopDatePicker/DesktopDatePicker.tsx +++ b/packages/x-date-pickers/src/DesktopDatePicker/DesktopDatePicker.tsx @@ -32,11 +32,11 @@ type DesktopDatePickerComponent = (( * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * * API: * - * - [DesktopDatePicker API](https://mui.com/api/desktop-date-picker/) + * - [DesktopDatePicker API](https://mui.com/x/api/date-pickers/desktop-date-picker/) */ export const DesktopDatePicker = React.forwardRef(function DesktopDatePicker( inProps: DesktopDatePickerProps, @@ -287,11 +287,11 @@ DesktopDatePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -305,7 +305,7 @@ DesktopDatePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -314,7 +314,7 @@ DesktopDatePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } @@ -381,7 +381,7 @@ DesktopDatePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx b/packages/x-date-pickers/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx index 218204f1dbd2..0d1b6d64a12b 100644 --- a/packages/x-date-pickers/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx +++ b/packages/x-date-pickers/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx @@ -35,11 +35,11 @@ type DesktopDateTimePickerComponent = (( * * Demos: * - * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/) + * - [Date Time Picker](https://mui.com/x/react-date-pickers/date-time-picker/) * * API: * - * - [DesktopDateTimePicker API](https://mui.com/api/desktop-date-time-picker/) + * - [DesktopDateTimePicker API](https://mui.com/x/api/date-pickers/desktop-date-time-picker/) */ export const DesktopDateTimePicker = React.forwardRef(function DesktopDateTimePicker( inProps: DesktopDateTimePickerProps, @@ -346,11 +346,11 @@ DesktopDateTimePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -364,7 +364,7 @@ DesktopDateTimePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -373,7 +373,7 @@ DesktopDateTimePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } @@ -452,7 +452,7 @@ DesktopDateTimePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers/src/DesktopTimePicker/DesktopTimePicker.tsx b/packages/x-date-pickers/src/DesktopTimePicker/DesktopTimePicker.tsx index c4c36ba60125..32819b834cfb 100644 --- a/packages/x-date-pickers/src/DesktopTimePicker/DesktopTimePicker.tsx +++ b/packages/x-date-pickers/src/DesktopTimePicker/DesktopTimePicker.tsx @@ -32,11 +32,11 @@ type DesktopTimePickerComponent = (( * * Demos: * - * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/) + * - [Time Picker](https://mui.com/x/react-date-pickers/time-picker/) * * API: * - * - [DesktopTimePicker API](https://mui.com/api/desktop-time-picker/) + * - [DesktopTimePicker API](https://mui.com/x/api/date-pickers/desktop-time-picker/) */ export const DesktopTimePicker = React.forwardRef(function DesktopTimePicker( inProps: DesktopTimePickerProps, @@ -264,11 +264,11 @@ DesktopTimePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -277,7 +277,7 @@ DesktopTimePicker.propTypes = { readOnly: PropTypes.bool, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } @@ -324,7 +324,7 @@ DesktopTimePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers/src/MobileDatePicker/MobileDatePicker.tsx b/packages/x-date-pickers/src/MobileDatePicker/MobileDatePicker.tsx index 6b76f97d26c5..3aa0369deada 100644 --- a/packages/x-date-pickers/src/MobileDatePicker/MobileDatePicker.tsx +++ b/packages/x-date-pickers/src/MobileDatePicker/MobileDatePicker.tsx @@ -29,11 +29,11 @@ type MobileDatePickerComponent = (( * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * * API: * - * - [MobileDatePicker API](https://mui.com/api/mobile-date-picker/) + * - [MobileDatePicker API](https://mui.com/x/api/date-pickers/mobile-date-picker/) */ export const MobileDatePicker = React.forwardRef(function MobileDatePicker( inProps: MobileDatePickerProps, @@ -124,7 +124,7 @@ MobileDatePicker.propTypes = { */ defaultCalendarMonth: PropTypes.any, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -296,7 +296,7 @@ MobileDatePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -305,7 +305,7 @@ MobileDatePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-date-pickers/src/MobileDateTimePicker/MobileDateTimePicker.tsx b/packages/x-date-pickers/src/MobileDateTimePicker/MobileDateTimePicker.tsx index 2fc35d0bb755..5b3f0353472f 100644 --- a/packages/x-date-pickers/src/MobileDateTimePicker/MobileDateTimePicker.tsx +++ b/packages/x-date-pickers/src/MobileDateTimePicker/MobileDateTimePicker.tsx @@ -32,11 +32,11 @@ type MobileDateTimePickerComponent = (( * * Demos: * - * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/) + * - [Date Time Picker](https://mui.com/x/react-date-pickers/date-time-picker/) * * API: * - * - [MobileDateTimePicker API](https://mui.com/api/mobile-date-time-picker/) + * - [MobileDateTimePicker API](https://mui.com/x/api/date-pickers/mobile-date-time-picker/) */ export const MobileDateTimePicker = React.forwardRef(function MobileDateTimePicker( inProps: MobileDateTimePickerProps, @@ -141,7 +141,7 @@ MobileDateTimePicker.propTypes = { */ defaultCalendarMonth: PropTypes.any, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -361,7 +361,7 @@ MobileDateTimePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -370,7 +370,7 @@ MobileDateTimePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-date-pickers/src/MobileTimePicker/MobileTimePicker.tsx b/packages/x-date-pickers/src/MobileTimePicker/MobileTimePicker.tsx index dd795a8c512e..76cff87aeaeb 100644 --- a/packages/x-date-pickers/src/MobileTimePicker/MobileTimePicker.tsx +++ b/packages/x-date-pickers/src/MobileTimePicker/MobileTimePicker.tsx @@ -29,11 +29,11 @@ type MobileTimePickerComponent = (( * * Demos: * - * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/) + * - [Time Picker](https://mui.com/x/react-date-pickers/time-picker/) * * API: * - * - [MobileTimePicker API](https://mui.com/api/mobile-time-picker/) + * - [MobileTimePicker API](https://mui.com/x/api/date-pickers/mobile-time-picker/) */ export const MobileTimePicker = React.forwardRef(function MobileTimePicker( inProps: MobileTimePickerProps, @@ -119,7 +119,7 @@ MobileTimePicker.propTypes = { */ components: PropTypes.object, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -274,7 +274,7 @@ MobileTimePicker.propTypes = { readOnly: PropTypes.bool, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-date-pickers/src/PickersDay/PickersDay.tsx b/packages/x-date-pickers/src/PickersDay/PickersDay.tsx index 197e2438a3f7..fe71ef75706c 100644 --- a/packages/x-date-pickers/src/PickersDay/PickersDay.tsx +++ b/packages/x-date-pickers/src/PickersDay/PickersDay.tsx @@ -436,10 +436,10 @@ PickersDayRaw.propTypes = { * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * * API: * - * - [PickersDay API](https://mui.com/api/pickers-day/) + * - [PickersDay API](https://mui.com/x/api/date-pickers/pickers-day/) */ export const PickersDay = React.memo(PickersDayRaw, areDayPropsEqual) as PickersDayComponent; diff --git a/packages/x-date-pickers/src/StaticDatePicker/StaticDatePicker.tsx b/packages/x-date-pickers/src/StaticDatePicker/StaticDatePicker.tsx index 7f205c1fc8dc..b6d1da098bab 100644 --- a/packages/x-date-pickers/src/StaticDatePicker/StaticDatePicker.tsx +++ b/packages/x-date-pickers/src/StaticDatePicker/StaticDatePicker.tsx @@ -35,11 +35,11 @@ type StaticDatePickerComponent = (( * * Demos: * - * - [Date Picker](https://mui.com/components/x/react-date-pickers/date-picker/) + * - [Date Picker](https://mui.com/x/react-date-pickers/date-picker/) * * API: * - * - [StaticDatePicker API](https://mui.com/api/static-date-picker/) + * - [StaticDatePicker API](https://mui.com/x/api/date-pickers/static-date-picker/) */ export const StaticDatePicker = React.forwardRef(function StaticDatePicker( inProps: StaticDatePickerProps, @@ -282,7 +282,7 @@ StaticDatePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -291,7 +291,7 @@ StaticDatePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-date-pickers/src/StaticDateTimePicker/StaticDateTimePicker.tsx b/packages/x-date-pickers/src/StaticDateTimePicker/StaticDateTimePicker.tsx index 27a31a1ce186..30d87b1c32d1 100644 --- a/packages/x-date-pickers/src/StaticDateTimePicker/StaticDateTimePicker.tsx +++ b/packages/x-date-pickers/src/StaticDateTimePicker/StaticDateTimePicker.tsx @@ -38,11 +38,11 @@ type StaticDateTimePickerComponent = (( * * Demos: * - * - [Date Time Picker](https://mui.com/components/x/react-date-pickers/date-time-picker/) + * - [Date Time Picker](https://mui.com/x/react-date-pickers/date-time-picker/) * * API: * - * - [StaticDateTimePicker API](https://mui.com/api/static-date-time-picker/) + * - [StaticDateTimePicker API](https://mui.com/x/api/date-pickers/static-date-time-picker/) */ export const StaticDateTimePicker = React.forwardRef(function StaticDateTimePicker( inProps: StaticDateTimePickerProps, @@ -347,7 +347,7 @@ StaticDateTimePicker.propTypes = { */ reduceAnimations: PropTypes.bool, /** - * Custom renderer for day. Check the [PickersDay](https://mui.com/api/pickers-day/) component. + * Custom renderer for day. Check the [PickersDay](https://mui.com/x/api/date-pickers/pickers-day/) component. * @param {TDate} day The day to render. * @param {Array} selectedDates The dates currently selected. * @param {PickersDayProps} pickersDayProps The props of the day to render. @@ -356,7 +356,7 @@ StaticDateTimePicker.propTypes = { renderDay: PropTypes.func, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx b/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx index 7383de46cc85..e5f227507084 100644 --- a/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx +++ b/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx @@ -35,11 +35,11 @@ type StaticTimePickerComponent = (( * * Demos: * - * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/) + * - [Time Picker](https://mui.com/x/react-date-pickers/time-picker/) * * API: * - * - [StaticTimePicker API](https://mui.com/api/static-time-picker/) + * - [StaticTimePicker API](https://mui.com/x/api/date-pickers/static-time-picker/) */ export const StaticTimePicker = React.forwardRef(function StaticTimePicker( inProps: StaticTimePickerProps, @@ -258,7 +258,7 @@ StaticTimePicker.propTypes = { readOnly: PropTypes.bool, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-date-pickers/src/TimePicker/TimePicker.tsx b/packages/x-date-pickers/src/TimePicker/TimePicker.tsx index 042b82e57f70..f44c2613ab78 100644 --- a/packages/x-date-pickers/src/TimePicker/TimePicker.tsx +++ b/packages/x-date-pickers/src/TimePicker/TimePicker.tsx @@ -25,11 +25,11 @@ type TimePickerComponent = (( * Demos: * * - [Pickers](https://mui.com/x/react-date-pickers/) - * - [Time Picker](https://mui.com/components/x/react-date-pickers/time-picker/) + * - [Time Picker](https://mui.com/x/react-date-pickers/time-picker/) * * API: * - * - [TimePicker API](https://mui.com/api/time-picker/) + * - [TimePicker API](https://mui.com/x/api/date-pickers/time-picker/) */ export const TimePicker = React.forwardRef(function TimePicker( inProps: TimePickerProps, @@ -130,7 +130,7 @@ TimePicker.propTypes = { */ desktopModeMediaQuery: PropTypes.string, /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps: PropTypes.object, /** @@ -280,11 +280,11 @@ TimePicker.propTypes = { */ orientation: PropTypes.oneOf(['landscape', 'portrait']), /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps: PropTypes.object, /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps: PropTypes.object, /** @@ -293,7 +293,7 @@ TimePicker.propTypes = { readOnly: PropTypes.bool, /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } @@ -350,7 +350,7 @@ TimePicker.propTypes = { */ toolbarTitle: PropTypes.node, /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent: PropTypes.elementType, /** diff --git a/packages/x-date-pickers/src/internals/components/PickersModalDialog.tsx b/packages/x-date-pickers/src/internals/components/PickersModalDialog.tsx index 597683664ef6..d73bc1466d1b 100644 --- a/packages/x-date-pickers/src/internals/components/PickersModalDialog.tsx +++ b/packages/x-date-pickers/src/internals/components/PickersModalDialog.tsx @@ -38,7 +38,7 @@ export interface ExportedPickerModalProps { */ showTodayButton?: boolean; /** - * Props applied to the [`Dialog`](/api/dialog/) element. + * Props applied to the [`Dialog`](https://mui.com/material-ui/api/dialog/) element. */ DialogProps?: Partial; } diff --git a/packages/x-date-pickers/src/internals/components/PickersPopper.tsx b/packages/x-date-pickers/src/internals/components/PickersPopper.tsx index 173c386bc480..19cc5d88a7cf 100644 --- a/packages/x-date-pickers/src/internals/components/PickersPopper.tsx +++ b/packages/x-date-pickers/src/internals/components/PickersPopper.tsx @@ -21,18 +21,18 @@ export interface ExportedPickerPaperProps { */ clearText?: React.ReactNode; /** - * Paper props passed down to [Paper](https://mui.com/api/paper/) component. + * Paper props passed down to [Paper](https://mui.com/material-ui/api/paper/) component. */ PaperProps?: Partial; } export interface ExportedPickerPopperProps { /** - * Popper props passed down to [Popper](https://mui.com/api/popper/) component. + * Popper props passed down to [Popper](https://mui.com/material-ui/api/popper/) component. */ PopperProps?: Partial; /** - * Custom component for popper [Transition](https://mui.com/components/transitions/#transitioncomponent-prop). + * Custom component for popper [Transition](https://mui.com/material-ui/transitions/#transitioncomponent-prop). */ TransitionComponent?: React.JSXElementConstructor; } diff --git a/packages/x-date-pickers/src/internals/components/PureDateInput.tsx b/packages/x-date-pickers/src/internals/components/PureDateInput.tsx index 16019aa7e851..df1ac20ebd19 100644 --- a/packages/x-date-pickers/src/internals/components/PureDateInput.tsx +++ b/packages/x-date-pickers/src/internals/components/PureDateInput.tsx @@ -78,7 +78,7 @@ export interface DateInputProps, TDateValue readOnly?: boolean; /** * The `renderInput` prop allows you to customize the rendered input. - * The `props` argument of this render prop contains props of [TextField](https://mui.com/api/text-field/#textfield-api) that you need to forward. + * The `props` argument of this render prop contains props of [TextField](https://mui.com/material-ui/api/text-field/#props) that you need to forward. * Pay specific attention to the `ref` and `inputProps` keys. * @example ```jsx * renderInput={props => } diff --git a/packages/x-license-pro/LICENSE.txt b/packages/x-license-pro/LICENSE similarity index 100% rename from packages/x-license-pro/LICENSE.txt rename to packages/x-license-pro/LICENSE diff --git a/packages/x-license-pro/package.json b/packages/x-license-pro/package.json index 26b854161131..75171616f6d9 100644 --- a/packages/x-license-pro/package.json +++ b/packages/x-license-pro/package.json @@ -4,11 +4,11 @@ "description": "MUI X License verification", "author": "MUI Team", "main": "src/index.ts", - "license": "SEE LICENSE IN LICENSE.txt", + "license": "SEE LICENSE IN LICENSE", "bugs": { "url": "https://github.com/mui/mui-x/issues" }, - "homepage": "https://mui.com/components/data-grid/", + "homepage": "https://mui.com/x/react-data-grid/", "sideEffects": false, "publishConfig": { "access": "public" diff --git a/test/e2e-website/data-grid-current.spec.ts b/test/e2e-website/data-grid-current.spec.ts deleted file mode 100644 index 94184964fac6..000000000000 --- a/test/e2e-website/data-grid-current.spec.ts +++ /dev/null @@ -1,129 +0,0 @@ -import { test as base, expect, Page } from '@playwright/test'; -import kebabCase from 'lodash/kebabCase'; -import FEATURE_TOGGLE from 'docs/src/featureToggle'; -import { TestFixture } from './playwright.config'; - -const test = base.extend({}); - -test.beforeEach(async ({}) => { - test.skip(FEATURE_TOGGLE.enable_redirects, 'Migration is done.'); -}); - -test.describe('DataGrid docs', () => { - test('should have correct link with hash in the TOC', async ({ page }) => { - await page.goto(`/components/data-grid/getting-started/`); - - const anchors = page.locator('[aria-label="Page table of contents"] ul a'); - - const firstAnchor = anchors.first(); - const textContent = await firstAnchor.textContent(); - - await expect(firstAnchor).toHaveAttribute( - 'href', - `/components/data-grid/getting-started/#${kebabCase(textContent || '')}`, - ); - }); - - test.describe('Demo page', () => { - test('should have correct link for API section', async ({ page }) => { - await page.goto(`/components/data-grid/`); - - const anchors = page.locator('div > h2#heading-api ~ ul a'); - - const firstAnchor = anchors.first(); - const textContent = await firstAnchor.textContent(); - - await expect(firstAnchor).toHaveAttribute( - 'href', - `/api/data-grid/${kebabCase(textContent || '')}/`, - ); - }); - - test('should have correct link for sidebar anchor', async ({ page }) => { - await page.goto(`/components/data-grid/`); - - const anchor = page.locator('nav[aria-label="documentation"] ul ul a:text-is("Overview")'); - await anchor.waitFor(); - - await expect(anchor).toHaveAttribute('href', `/components/data-grid/`); - }); - }); - - test.describe('API page', () => { - test('should have correct link for sidebar anchor', async ({ page }) => { - await page.goto(`/api/data-grid/data-grid/`); - - const anchor = page.locator('nav[aria-label="documentation"] ul ul a:text-is("DataGrid")'); - await anchor.waitFor(); - - await expect(anchor).toHaveAttribute('app-drawer-active', ''); - await expect(anchor).toHaveAttribute('href', `/api/data-grid/data-grid/`); - }); - - test('all the links in the main content should have correct prefix', async ({ page }) => { - await page.goto(`/api/data-grid/data-grid/`); - - const anchors = page.locator('div#main-content a'); - - const handles = await anchors.elementHandles(); - - const links = await Promise.all(handles.map((elm) => elm.getAttribute('href'))); - - links.forEach((link) => { - expect(link?.startsWith('/x/data-grid')).toBeFalsy(); - }); - }); - }); - - test.describe('Search', () => { - const retryToggleSearch = async (page: Page, count = 3) => { - try { - await page.keyboard.press('Meta+k'); - await page.waitForSelector('input#docsearch-input', { timeout: 2000 }); - } catch (error) { - if (count === 0) { - throw error; - } - await retryToggleSearch(page, count - 1); - } - }; - test('should have correct link when searching component', async ({ page }) => { - await page.goto(`/components/data-grid/getting-started/`); - - await retryToggleSearch(page); - - await page.type('input#docsearch-input', 'datagrid', { delay: 50 }); - - const anchor = page.locator('.DocSearch-Hits a:has-text("Data Grid - Components")').first(); - await anchor.waitFor(); - - await expect(anchor).toHaveAttribute('href', /^\/components\/data-grid\//); - }); - - test('should have correct link when searching API', async ({ page }) => { - await page.goto(`/components/data-grid/getting-started/`); - - await retryToggleSearch(page); - - await page.type('input#docsearch-input', 'datagrid api', { delay: 50 }); - - const anchor = page.locator('.DocSearch-Hits a:has-text("DataGrid API")').first(); - await anchor.waitFor(); - - await expect(anchor).toHaveAttribute('href', `/api/data-grid/data-grid/#main-content`); - }); - - test('should have correct link when searching pro API', async ({ page }) => { - await page.goto(`/components/data-grid/getting-started/`); - - await retryToggleSearch(page); - - await page.type('input#docsearch-input', 'datagridpro api', { delay: 50 }); - - const anchor = page.locator('.DocSearch-Hits a:has-text("DataGridPro API")').first(); - await anchor.waitFor(); - - await expect(anchor).toHaveAttribute('href', `/api/data-grid/data-grid-pro/#main-content`); - }); - }); -}); diff --git a/test/e2e-website/data-grid-redirects.spec.ts b/test/e2e-website/data-grid-redirects.spec.ts deleted file mode 100644 index 88a65d83a9a0..000000000000 --- a/test/e2e-website/data-grid-redirects.spec.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { test as base, expect } from '@playwright/test'; -import FEATURE_TOGGLE from 'docs/src/featureToggle'; -import { TestFixture } from './playwright.config'; - -const test = base.extend({}); - -test.beforeEach(async ({}) => { - test.skip(!FEATURE_TOGGLE.enable_redirects, "Redirects haven't started yet"); -}); - -test(`overview should redirect correctly`, async ({ page }) => { - await page.goto(`/components/data-grid/`); - - await expect(page).toHaveURL(`/x/react-data-grid/`); - - await expect(page.locator('h1')).toHaveText('Data Grid'); -}); - -test(`demo should redirect correctly`, async ({ page }) => { - await page.goto(`/components/data-grid/demo/`); - - await expect(page).toHaveURL(`/x/react-data-grid/demo/`); - - await expect(page.locator('h1')).toHaveText('Data Grid - Demo'); -}); - -test(`data grid api should redirect correctly`, async ({ page }) => { - await page.goto(`/api/data-grid/data-grid/`); - - await expect(page).toHaveURL(`/x/api/data-grid/data-grid/`); - - await expect(page.locator('h1')).toHaveText('DataGrid API'); -}); diff --git a/test/e2e-website/data-grid-new.spec.ts b/test/e2e-website/data-grid.spec.ts similarity index 98% rename from test/e2e-website/data-grid-new.spec.ts rename to test/e2e-website/data-grid.spec.ts index 08db0c389f11..53588350a95c 100644 --- a/test/e2e-website/data-grid-new.spec.ts +++ b/test/e2e-website/data-grid.spec.ts @@ -45,6 +45,7 @@ test.describe('DataGrid docs', () => { const anchor = page.locator('nav[aria-label="documentation"] ul ul a:text-is("Overview")'); await anchor.waitFor(); + await expect(anchor).toHaveAttribute('app-drawer-active', ''); await expect(anchor).toHaveAttribute('href', `/x/react-data-grid/`); }); }); diff --git a/yarn.lock b/yarn.lock index 7c63d8e2abc9..b37606726394 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2582,8 +2582,8 @@ react-transition-group "^4.4.2" "@mui/monorepo@https://github.com/mui/material-ui.git#master": - version "5.5.2" - resolved "https://github.com/mui/material-ui.git#dd411b017ea7504a14a16821b694ac6aa01d9b6d" + version "5.6.0" + resolved "https://github.com/mui/material-ui.git#b31d6a3fdc28e5df2072cb717e117231002d1358" "@mui/private-theming@^5.4.4": version "5.4.4" @@ -4651,14 +4651,14 @@ dependencies: "@types/node" "*" -"@typescript-eslint/eslint-plugin@^5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.16.0.tgz#78f246dd8d1b528fc5bfca99a8a64d4023a3d86d" - integrity sha512-SJoba1edXvQRMmNI505Uo4XmGbxCK9ARQpkvOd00anxzri9RNQk0DDCxD+LIl+jYhkzOJiOMMKYEHnHEODjdCw== +"@typescript-eslint/eslint-plugin@^5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.18.0.tgz#950df411cec65f90d75d6320a03b2c98f6c3af7d" + integrity sha512-tzrmdGMJI/uii9/V6lurMo4/o+dMTKDH82LkNjhJ3adCW22YQydoRs5MwTiqxGF9CSYxPxQ7EYb4jLNlIs+E+A== dependencies: - "@typescript-eslint/scope-manager" "5.16.0" - "@typescript-eslint/type-utils" "5.16.0" - "@typescript-eslint/utils" "5.16.0" + "@typescript-eslint/scope-manager" "5.18.0" + "@typescript-eslint/type-utils" "5.18.0" + "@typescript-eslint/utils" "5.18.0" debug "^4.3.2" functional-red-black-tree "^1.0.1" ignore "^5.1.8" @@ -4666,12 +4666,12 @@ semver "^7.3.5" tsutils "^3.21.0" -"@typescript-eslint/experimental-utils@^5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-5.16.0.tgz#0b852567efa10660047f281cf004ed3db32866da" - integrity sha512-bitZtqO13XX64/UOQKoDbVg2H4VHzbHnWWlTRc7ofq7SuQyPCwEycF1Zmn5ZAMTJZ3p5uMS7xJGUdOtZK7LrNw== +"@typescript-eslint/experimental-utils@^5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/experimental-utils/-/experimental-utils-5.18.0.tgz#a6b5662e6b0452cb0e75a13662ce3b33cd1be59d" + integrity sha512-hypiw5N0aM2aH91/uMmG7RpyUH3PN/iOhilMwkMFZIbm/Bn/G3ZnbaYdSoAN4PG/XHQjdhBYLi0ZoRZsRYT4hA== dependencies: - "@typescript-eslint/utils" "5.16.0" + "@typescript-eslint/utils" "5.18.0" "@typescript-eslint/parser@^4.4.1": version "4.33.0" @@ -4683,14 +4683,14 @@ "@typescript-eslint/typescript-estree" "4.33.0" debug "^4.3.1" -"@typescript-eslint/parser@^5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-5.16.0.tgz#e4de1bde4b4dad5b6124d3da227347616ed55508" - integrity sha512-fkDq86F0zl8FicnJtdXakFs4lnuebH6ZADDw6CYQv0UZeIjHvmEw87m9/29nk2Dv5Lmdp0zQ3zDQhiMWQf/GbA== +"@typescript-eslint/parser@^5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/parser/-/parser-5.18.0.tgz#2bcd4ff21df33621df33e942ccb21cb897f004c6" + integrity sha512-+08nYfurBzSSPndngnHvFw/fniWYJ5ymOrn/63oMIbgomVQOvIDhBoJmYZ9lwQOCnQV9xHGvf88ze3jFGUYooQ== dependencies: - "@typescript-eslint/scope-manager" "5.16.0" - "@typescript-eslint/types" "5.16.0" - "@typescript-eslint/typescript-estree" "5.16.0" + "@typescript-eslint/scope-manager" "5.18.0" + "@typescript-eslint/types" "5.18.0" + "@typescript-eslint/typescript-estree" "5.18.0" debug "^4.3.2" "@typescript-eslint/scope-manager@4.33.0": @@ -4701,20 +4701,20 @@ "@typescript-eslint/types" "4.33.0" "@typescript-eslint/visitor-keys" "4.33.0" -"@typescript-eslint/scope-manager@5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.16.0.tgz#7e7909d64bd0c4d8aef629cdc764b9d3e1d3a69a" - integrity sha512-P+Yab2Hovg8NekLIR/mOElCDPyGgFZKhGoZA901Yax6WR6HVeGLbsqJkZ+Cvk5nts/dAlFKm8PfL43UZnWdpIQ== +"@typescript-eslint/scope-manager@5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/scope-manager/-/scope-manager-5.18.0.tgz#a7d7b49b973ba8cebf2a3710eefd457ef2fb5505" + integrity sha512-C0CZML6NyRDj+ZbMqh9FnPscg2PrzSaVQg3IpTmpe0NURMVBXlghGZgMYqBw07YW73i0MCqSDqv2SbywnCS8jQ== dependencies: - "@typescript-eslint/types" "5.16.0" - "@typescript-eslint/visitor-keys" "5.16.0" + "@typescript-eslint/types" "5.18.0" + "@typescript-eslint/visitor-keys" "5.18.0" -"@typescript-eslint/type-utils@5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-5.16.0.tgz#b482bdde1d7d7c0c7080f7f2f67ea9580b9e0692" - integrity sha512-SKygICv54CCRl1Vq5ewwQUJV/8padIWvPgCxlWPGO/OgQLCijY9G7lDu6H+mqfQtbzDNlVjzVWQmeqbLMBLEwQ== +"@typescript-eslint/type-utils@5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/type-utils/-/type-utils-5.18.0.tgz#62dbfc8478abf36ba94a90ddf10be3cc8e471c74" + integrity sha512-vcn9/6J5D6jtHxpEJrgK8FhaM8r6J1/ZiNu70ZUJN554Y3D9t3iovi6u7JF8l/e7FcBIxeuTEidZDR70UuCIfA== dependencies: - "@typescript-eslint/utils" "5.16.0" + "@typescript-eslint/utils" "5.18.0" debug "^4.3.2" tsutils "^3.21.0" @@ -4723,10 +4723,10 @@ resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-4.33.0.tgz#a1e59036a3b53ae8430ceebf2a919dc7f9af6d72" integrity sha512-zKp7CjQzLQImXEpLt2BUw1tvOMPfNoTAfb8l51evhYbOEEzdWyQNmHWWGPR6hwKJDAi+1VXSBmnhL9kyVTTOuQ== -"@typescript-eslint/types@5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.16.0.tgz#5827b011982950ed350f075eaecb7f47d3c643ee" - integrity sha512-oUorOwLj/3/3p/HFwrp6m/J2VfbLC8gjW5X3awpQJ/bSG+YRGFS4dpsvtQ8T2VNveV+LflQHjlLvB6v0R87z4g== +"@typescript-eslint/types@5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/types/-/types-5.18.0.tgz#4f0425d85fdb863071680983853c59a62ce9566e" + integrity sha512-bhV1+XjM+9bHMTmXi46p1Led5NP6iqQcsOxgx7fvk6gGiV48c6IynY0apQb7693twJDsXiVzNXTflhplmaiJaw== "@typescript-eslint/typescript-estree@4.33.0": version "4.33.0" @@ -4741,28 +4741,28 @@ semver "^7.3.5" tsutils "^3.21.0" -"@typescript-eslint/typescript-estree@5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.16.0.tgz#32259459ec62f5feddca66adc695342f30101f61" - integrity sha512-SE4VfbLWUZl9MR+ngLSARptUv2E8brY0luCdgmUevU6arZRY/KxYoLI/3V/yxaURR8tLRN7bmZtJdgmzLHI6pQ== +"@typescript-eslint/typescript-estree@5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/typescript-estree/-/typescript-estree-5.18.0.tgz#6498e5ee69a32e82b6e18689e2f72e4060986474" + integrity sha512-wa+2VAhOPpZs1bVij9e5gyVu60ReMi/KuOx4LKjGx2Y3XTNUDJgQ+5f77D49pHtqef/klglf+mibuHs9TrPxdQ== dependencies: - "@typescript-eslint/types" "5.16.0" - "@typescript-eslint/visitor-keys" "5.16.0" + "@typescript-eslint/types" "5.18.0" + "@typescript-eslint/visitor-keys" "5.18.0" debug "^4.3.2" globby "^11.0.4" is-glob "^4.0.3" semver "^7.3.5" tsutils "^3.21.0" -"@typescript-eslint/utils@5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.16.0.tgz#42218b459d6d66418a4eb199a382bdc261650679" - integrity sha512-iYej2ER6AwmejLWMWzJIHy3nPJeGDuCqf8Jnb+jAQVoPpmWzwQOfa9hWVB8GIQE5gsCv/rfN4T+AYb/V06WseQ== +"@typescript-eslint/utils@5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-5.18.0.tgz#27fc84cf95c1a96def0aae31684cb43a37e76855" + integrity sha512-+hFGWUMMri7OFY26TsOlGa+zgjEy1ssEipxpLjtl4wSll8zy85x0GrUSju/FHdKfVorZPYJLkF3I4XPtnCTewA== dependencies: "@types/json-schema" "^7.0.9" - "@typescript-eslint/scope-manager" "5.16.0" - "@typescript-eslint/types" "5.16.0" - "@typescript-eslint/typescript-estree" "5.16.0" + "@typescript-eslint/scope-manager" "5.18.0" + "@typescript-eslint/types" "5.18.0" + "@typescript-eslint/typescript-estree" "5.18.0" eslint-scope "^5.1.1" eslint-utils "^3.0.0" @@ -4774,12 +4774,12 @@ "@typescript-eslint/types" "4.33.0" eslint-visitor-keys "^2.0.0" -"@typescript-eslint/visitor-keys@5.16.0": - version "5.16.0" - resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.16.0.tgz#f27dc3b943e6317264c7492e390c6844cd4efbbb" - integrity sha512-jqxO8msp5vZDhikTwq9ubyMHqZ67UIvawohr4qF3KhlpL7gzSjOd+8471H3nh5LyABkaI85laEKKU8SnGUK5/g== +"@typescript-eslint/visitor-keys@5.18.0": + version "5.18.0" + resolved "https://registry.yarnpkg.com/@typescript-eslint/visitor-keys/-/visitor-keys-5.18.0.tgz#c7c07709823804171d569017f3b031ced7253e60" + integrity sha512-Hf+t+dJsjAKpKSkg3EHvbtEpFFb/1CiOHnvI8bjHgOD4/wAw3gKrA0i94LrbekypiZVanJu3McWJg7rWDMzRTg== dependencies: - "@typescript-eslint/types" "5.16.0" + "@typescript-eslint/types" "5.18.0" eslint-visitor-keys "^3.0.0" "@ungap/promise-all-settled@1.1.2": @@ -7023,10 +7023,10 @@ clean-css@^4.2.3: dependencies: source-map "~0.6.0" -clean-css@^5.1.5, clean-css@^5.2.4: - version "5.2.4" - resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.2.4.tgz#982b058f8581adb2ae062520808fb2429bd487a4" - integrity sha512-nKseG8wCzEuji/4yrgM/5cthL9oTDc5UOQyFMvW/Q53oP6gLH690o1NbuTh6Y18nujr7BxlsFuS7gXLnLzKJGg== +clean-css@^5.1.5, clean-css@^5.3.0: + version "5.3.0" + resolved "https://registry.yarnpkg.com/clean-css/-/clean-css-5.3.0.tgz#ad3d8238d5f3549e83d5f87205189494bc7cbb59" + integrity sha512-YYuuxv4H/iNb1Z/5IbMRoxgrzjWGhOEFfd+groZ5dMCVkpENiMZmwspdrzBo9286JjM1gZJPAyL7ZIdzuvu2AQ== dependencies: source-map "~0.6.0" @@ -7358,10 +7358,10 @@ concat-stream@^2.0.0: readable-stream "^3.0.2" typedarray "^0.0.6" -concurrently@^7.0.0: - version "7.0.0" - resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-7.0.0.tgz#78d31b441cec338dab03316c221a2f9a67c529b0" - integrity sha512-WKM7PUsI8wyXpF80H+zjHP32fsgsHNQfPLw/e70Z5dYkV7hF+rf8q3D+ScWJIEr57CpkO3OWBko6hwhQLPR8Pw== +concurrently@^7.1.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-7.1.0.tgz#477b49b8cfc630bb491f9b02e9ed7fb7bff02942" + integrity sha512-Bz0tMlYKZRUDqJlNiF/OImojMB9ruKUz6GCfmhFnSapXgPe+3xzY4byqoKG9tUZ7L2PGEUjfLPOLfIX3labnmw== dependencies: chalk "^4.1.0" date-fns "^2.16.1" @@ -8125,12 +8125,7 @@ date-fns-jalali@^2.21.3-1: resolved "https://registry.yarnpkg.com/date-fns-jalali/-/date-fns-jalali-2.21.3-1.tgz#b87a01c1d7bb2fe827faed34b33478a5fe4aa027" integrity sha512-Sgw1IdgCgyWDKCpq6uwAu24vPMOtvmcXXXuETr1jQO/aVj4h23XAltcP7hLbo+osqoiJnPmiydbI/q1W7TYAjA== -date-fns@^2.16.1: - version "2.17.0" - resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.17.0.tgz#afa55daea539239db0a64e236ce716ef3d681ba1" - integrity sha512-ZEhqxUtEZeGgg9eHNSOAJ8O9xqSgiJdrL0lzSSfMF54x6KXWJiOH/xntSJ9YomJPrYH/p08t6gWjGWq1SDJlSA== - -date-fns@^2.27.0: +date-fns@^2.16.1, date-fns@^2.27.0: version "2.28.0" resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.28.0.tgz#9570d656f5fc13143e50c975a3b6bbeb46cd08b2" integrity sha512-8d35hViGYx/QH0icHYCeLmsLmMUheMmTyV9Fcm6gvNwdw31yXXH+O85sOBJ+OLnLQMKZowvpKb6FgMIQjcpvQw== @@ -9167,10 +9162,10 @@ eslint-plugin-import@^2.25.4: resolve "^1.20.0" tsconfig-paths "^3.12.0" -eslint-plugin-jsdoc@^38.1.3: - version "38.1.3" - resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-38.1.3.tgz#64ead0e535de02e2353ac271607e28e01e25c746" - integrity sha512-CJgBG1wzl2735rct2GpzS39lx4t0mlUiv9MvFndQKyqTVOGZLXeSkVNIE5inmg23T0EkCrS3AZ9dKbFAsK9ItA== +eslint-plugin-jsdoc@^38.1.6: + version "38.1.6" + resolved "https://registry.yarnpkg.com/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-38.1.6.tgz#7dfa2a6d38f550935c6a3668a1fc5a05b19e4069" + integrity sha512-n4s95oYlg0L43Bs8C0dkzIldxYf8pLCutC/tCbjIdF7VDiobuzPI+HZn9Q0BvgOvgPNgh5n7CSStql25HUG4Tw== dependencies: "@es-joy/jsdoccomment" "~0.22.1" comment-parser "1.3.1" @@ -9214,10 +9209,10 @@ eslint-plugin-prettier@^4.0.0: dependencies: prettier-linter-helpers "^1.0.0" -eslint-plugin-react-hooks@^4.3.0: - version "4.3.0" - resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.3.0.tgz#318dbf312e06fab1c835a4abef00121751ac1172" - integrity sha512-XslZy0LnMn+84NEG9jSGR6eGqaZB3133L8xewQo3fQagbQuGt7a63gf+P1NGKZavEYEC3UXaWEAA/AqDkuN6xA== +eslint-plugin-react-hooks@^4.4.0: + version "4.4.0" + resolved "https://registry.yarnpkg.com/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.4.0.tgz#71c39e528764c848d8253e1aa2c7024ed505f6c4" + integrity sha512-U3RVIfdzJaeKDQKEJbz5p3NW8/L80PCATJAfuojwbaEL+gBjfGdhUcGde+WGUW46Q5sr/NgxevsIiDtNXrvZaQ== eslint-plugin-react@^7.29.4: version "7.29.4" @@ -15134,10 +15129,10 @@ prettier-linter-helpers@^1.0.0: resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.3.0.tgz#b6a5bf1284026ae640f17f7ff5658a7567fc0d18" integrity sha512-kXtO4s0Lz/DW/IJ9QdWhAf7/NmPWQXkFr/r/WkR3vyI+0v8amTDxiaQSLzs8NBlytfLWX/7uQUMIW677yLKl4w== -prettier@^2.0.1, prettier@^2.6.1: - version "2.6.1" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.6.1.tgz#d472797e0d7461605c1609808e27b80c0f9cfe17" - integrity sha512-8UVbTBYGwN37Bs9LERmxCPjdvPxlEowx2urIL6urHzdb3SDq4B/Z6xLFCblrSnE4iKWcS6ziJ3aOYrc1kz/E2A== +prettier@^2.0.1, prettier@^2.6.2: + version "2.6.2" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.6.2.tgz#e26d71a18a74c3d0f0597f55f01fb6c06c206032" + integrity sha512-PkUpF+qoXTqhOeWL9fu7As8LXsIUZ1WYaJiY/a7McAQzxjk82OF0tibkFXVCDImZtWxbvojFjerkiLb0/q8mew== pretty-error@^2.1.1: version "2.1.1" @@ -15649,10 +15644,10 @@ react-helmet-async@^1.0.7: react-fast-compare "^3.2.0" shallowequal "^1.1.0" -react-hook-form@^7.28.1: - version "7.28.1" - resolved "https://registry.yarnpkg.com/react-hook-form/-/react-hook-form-7.28.1.tgz#95fc37be6c6b9d57212eb7eca055fb36d079b3b7" - integrity sha512-mgwxvXuvt3FMY/mdnWbPc++Zf1U5xYzkhOaL05mtFMLvXc9MvUhMUlKtUVuO12sOrgT3nPXBgVFawtiJ4ONrgg== +react-hook-form@^7.29.0: + version "7.29.0" + resolved "https://registry.yarnpkg.com/react-hook-form/-/react-hook-form-7.29.0.tgz#5e7e41a483b70731720966ed8be52163ea1fecf1" + integrity sha512-NcJqWRF6el5HMW30fqZRt27s+lorvlCCDbTpAyHoodQeYWXgQCvZJJQLC1kRMKdrJknVH0NIg3At6TUzlZJFOQ== react-inspector@^5.1.0: version "5.1.0" @@ -15709,18 +15704,18 @@ react-refresh@^0.11.0: resolved "https://registry.yarnpkg.com/react-refresh/-/react-refresh-0.11.0.tgz#77198b944733f0f1f1a90e791de4541f9f074046" integrity sha512-F27qZr8uUqwhWZboondsPx8tnC3Ct3SxZA3V5WyEvujRyyNv0VYPhoBg1gZ8/MV5tubQp76Trw8lTv9hzRBa+A== -react-router-dom@^6.0.0, react-router-dom@^6.2.2: - version "6.2.2" - resolved "https://registry.yarnpkg.com/react-router-dom/-/react-router-dom-6.2.2.tgz#f1a2c88365593c76b9612ae80154a13fcb72e442" - integrity sha512-AtYEsAST7bDD4dLSQHDnk/qxWLJdad5t1HFa1qJyUrCeGgEuCSw0VB/27ARbF9Fi/W5598ujvJOm3ujUCVzuYQ== +react-router-dom@^6.0.0, react-router-dom@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/react-router-dom/-/react-router-dom-6.3.0.tgz#a0216da813454e521905b5fa55e0e5176123f43d" + integrity sha512-uaJj7LKytRxZNQV8+RbzJWnJ8K2nPsOOEuX7aQstlMZKQT0164C+X2w6bnkqU3sjtLvpd5ojrezAyfZ1+0sStw== dependencies: history "^5.2.0" - react-router "6.2.2" + react-router "6.3.0" -react-router@6.2.2, react-router@^6.0.0, react-router@^6.2.2: - version "6.2.2" - resolved "https://registry.yarnpkg.com/react-router/-/react-router-6.2.2.tgz#495e683a0c04461eeb3d705fe445d6cf42f0c249" - integrity sha512-/MbxyLzd7Q7amp4gDOGaYvXwhEojkJD5BtExkuKmj39VEE0m3l/zipf6h2WIB2jyAO0lI6NGETh4RDcktRm4AQ== +react-router@6.3.0, react-router@^6.0.0, react-router@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/react-router/-/react-router-6.3.0.tgz#3970cc64b4cb4eae0c1ea5203a80334fdd175557" + integrity sha512-7Wh1DzVQ+tlFjkeo+ujvjSqSJmkt1+8JO+T5xklPlgrh70y7ogx75ODRW0ThWhY7S+6yEDks8TYrtQe/aoboBQ== dependencies: history "^5.2.0" @@ -18935,10 +18930,10 @@ webpack@4: watchpack "^1.7.4" webpack-sources "^1.4.1" -webpack@^5.70.0, webpack@^5.9.0: - version "5.70.0" - resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.70.0.tgz#3461e6287a72b5e6e2f4872700bc8de0d7500e6d" - integrity sha512-ZMWWy8CeuTTjCxbeaQI21xSswseF2oNOwc70QSKNePvmxE7XW36i7vpBMYZFAUHPwQiEbNGCEYIOOlyRbdGmxw== +webpack@^5.71.0, webpack@^5.9.0: + version "5.71.0" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.71.0.tgz#b01fcf379570b8c5ee06ca06c829ca168c951884" + integrity sha512-g4dFT7CFG8LY0iU5G8nBL6VlkT21Z7dcYDpJAEJV5Q1WLb9UwnFbrem1k7K52ILqEmomN7pnzWFxxE6SlDY56A== dependencies: "@types/eslint-scope" "^3.7.3" "@types/estree" "^0.0.51"