From 9b448a87baa8fc71d42344e955373214c075a23b Mon Sep 17 00:00:00 2001 From: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com> Date: Thu, 6 Jul 2023 13:35:23 +0200 Subject: [PATCH] [docs] Fix API links for pickers (#9573) --- benchmark/browser/README.md | 2 +- docs/README.md | 2 +- docs/data/charts/overview/overview.md | 9 +++- .../getting-started/getting-started.md | 18 ++++--- .../adapters-locale/adapters-locale.md | 1 + .../base-concepts/base-concepts.md | 1 + .../calendar-systems/calendar-systems.md | 1 + .../custom-components/custom-components.md | 1 + .../date-pickers/custom-field/custom-field.md | 1 + .../custom-layout/custom-layout.md | 1 + .../date-calendar/date-calendar.md | 1 + .../date-pickers/date-field/date-field.md | 1 + .../date-pickers/date-picker/date-picker.md | 1 + .../date-range-calendar.md | 1 + .../date-range-field/date-range-field.md | 1 + .../date-range-picker/date-range-picker.md | 1 + .../date-time-field/date-time-field.md | 1 + .../date-time-picker/date-time-picker.md | 1 + .../date-time-range-field.md | 1 + .../date-time-range-picker.md | 1 + .../digital-clock/digital-clock.md | 1 + docs/data/date-pickers/fields/fields.md | 1 + .../getting-started/getting-started.md | 19 ++++--- docs/data/date-pickers/lifecycle/lifecycle.md | 1 + .../date-pickers/localization/localization.md | 1 + docs/data/date-pickers/overview/overview.md | 1 + docs/data/date-pickers/shortcuts/shortcuts.md | 1 + .../date-pickers/time-clock/time-clock.md | 1 + .../date-pickers/time-field/time-field.md | 1 + .../date-pickers/time-picker/time-picker.md | 1 + .../time-range-field/time-range-field.md | 1 + .../time-range-picker/time-range-picker.md | 1 + docs/data/date-pickers/timezone/timezone.md | 1 + .../date-pickers/validation/validation.md | 1 + .../migration-data-grid-v5.md | 4 +- .../migration-pickers-lab.md | 20 +++++--- .../migration-pickers-v5.md | 4 +- .../components/InstallationInstructions.tsx | 2 +- packages/grid/x-data-grid-premium/README.md | 2 +- packages/grid/x-data-grid-pro/README.md | 2 +- packages/grid/x-data-grid/README.md | 2 +- packages/x-charts/README.md | 4 +- packages/x-codemod/README.md | 50 +++++++++---------- packages/x-date-pickers-pro/README.md | 4 +- packages/x-date-pickers/README.md | 4 +- scripts/README.md | 2 +- yarn.lock | 4 +- 47 files changed, 117 insertions(+), 66 deletions(-) diff --git a/benchmark/browser/README.md b/benchmark/browser/README.md index dbd42d089bf0..61f98c2b1b9e 100644 --- a/benchmark/browser/README.md +++ b/benchmark/browser/README.md @@ -2,7 +2,7 @@ This project is used when running the following command: -```sh +```bash yarn browser ``` diff --git a/docs/README.md b/docs/README.md index 488a3fe78c7e..24e443ce6740 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ This is the documentation website of MUI X. To start the docs site in development mode, from the project root, run: -```sh +```bash yarn && yarn docs:dev ``` diff --git a/docs/data/charts/overview/overview.md b/docs/data/charts/overview/overview.md index a2e74aafa126..1578352d5884 100644 --- a/docs/data/charts/overview/overview.md +++ b/docs/data/charts/overview/overview.md @@ -31,12 +31,17 @@ To modify the styling of charts you can rely on all the MUI styling tools, such To install this library, run -```sh + +```bash npm npm install @mui/x-charts -// or +``` + +```bash yarn yarn add @mui/x-charts ``` + + ## Display charts Charts can be rendered in two ways. diff --git a/docs/data/data-grid/getting-started/getting-started.md b/docs/data/data-grid/getting-started/getting-started.md index 41723d1b2449..f1aeef4f91b0 100644 --- a/docs/data/data-grid/getting-started/getting-started.md +++ b/docs/data/data-grid/getting-started/getting-started.md @@ -11,14 +11,17 @@ Using your favorite package manager, install `@mui/x-data-grid-pro` or `@mui/x-d The Data Grid package has a peer dependency on `@mui/material`. If you are not already using it in your project, you can install it with: -```sh -// with npm + +```bash npm npm install @mui/material @emotion/react @emotion/styled +``` -// with yarn +```bash yarn yarn add @mui/material @emotion/react @emotion/styled ``` + + Please note that [react](https://www.npmjs.com/package/react) and [react-dom](https://www.npmjs.com/package/react-dom) are peer dependencies too: @@ -34,14 +37,17 @@ Please note that [react](https://www.npmjs.com/package/react) and [react-dom](ht Material UI is using [Emotion](https://emotion.sh/docs/introduction) as a styling engine by default. If you want to use [`styled-components`](https://styled-components.com/) instead, run: -```sh -// with npm + +```bash npm npm install @mui/styled-engine-sc styled-components +``` -// with yarn +```bash yarn yarn add @mui/styled-engine-sc styled-components ``` + + 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 diff --git a/docs/data/date-pickers/adapters-locale/adapters-locale.md b/docs/data/date-pickers/adapters-locale/adapters-locale.md index 4871e78ac58e..246bb8dc800d 100644 --- a/docs/data/date-pickers/adapters-locale/adapters-locale.md +++ b/docs/data/date-pickers/adapters-locale/adapters-locale.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - Date localization components: LocalizationProvider githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/base-concepts/base-concepts.md b/docs/data/date-pickers/base-concepts/base-concepts.md index 3cabcfc612d1..3278d4ccd356 100644 --- a/docs/data/date-pickers/base-concepts/base-concepts.md +++ b/docs/data/date-pickers/base-concepts/base-concepts.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time Picker - Base concepts packageName: '@mui/x-date-pickers' githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/calendar-systems/calendar-systems.md b/docs/data/date-pickers/calendar-systems/calendar-systems.md index 4f3ab1d22cd0..6b0ba67760e2 100644 --- a/docs/data/date-pickers/calendar-systems/calendar-systems.md +++ b/docs/data/date-pickers/calendar-systems/calendar-systems.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - Calendar systems components: LocalizationProvider githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/custom-components/custom-components.md b/docs/data/date-pickers/custom-components/custom-components.md index b1e77732aebe..14e075881650 100644 --- a/docs/data/date-pickers/custom-components/custom-components.md +++ b/docs/data/date-pickers/custom-components/custom-components.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - Custom subcomponents components: DateTimePickerTabs --- diff --git a/docs/data/date-pickers/custom-field/custom-field.md b/docs/data/date-pickers/custom-field/custom-field.md index 3f24a3b298ec..1c28017b1de8 100644 --- a/docs/data/date-pickers/custom-field/custom-field.md +++ b/docs/data/date-pickers/custom-field/custom-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - Custom field githubLabel: 'component: pickers' packageName: '@mui/x-date-pickers' diff --git a/docs/data/date-pickers/custom-layout/custom-layout.md b/docs/data/date-pickers/custom-layout/custom-layout.md index 21dcd46a8621..fa72b2b08194 100644 --- a/docs/data/date-pickers/custom-layout/custom-layout.md +++ b/docs/data/date-pickers/custom-layout/custom-layout.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - Custom layout components: PickersActionBar, PickersLayout githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/date-calendar/date-calendar.md b/docs/data/date-pickers/date-calendar/date-calendar.md index bedfe91c8c3d..ebabb0e49ae8 100644 --- a/docs/data/date-pickers/date-calendar/date-calendar.md +++ b/docs/data/date-pickers/date-calendar/date-calendar.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Calendar component components: DateCalendar, MonthCalendar, YearCalendar, PickersDay, DayCalendarSkeleton githubLabel: 'component: DatePicker' diff --git a/docs/data/date-pickers/date-field/date-field.md b/docs/data/date-pickers/date-field/date-field.md index 871859a51ae3..7e99c6a29e68 100644 --- a/docs/data/date-pickers/date-field/date-field.md +++ b/docs/data/date-pickers/date-field/date-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Field component components: DateField githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/date-picker/date-picker.md b/docs/data/date-pickers/date-picker/date-picker.md index c28c448df5eb..a679b441b96b 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 @@ --- +productId: x-date-pickers title: React Date Picker component components: DatePicker, DesktopDatePicker, MobileDatePicker, StaticDatePicker githubLabel: 'component: DatePicker' diff --git a/docs/data/date-pickers/date-range-calendar/date-range-calendar.md b/docs/data/date-pickers/date-range-calendar/date-range-calendar.md index e603d0f4043e..2b334a6649ee 100644 --- a/docs/data/date-pickers/date-range-calendar/date-range-calendar.md +++ b/docs/data/date-pickers/date-range-calendar/date-range-calendar.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Range Calendar component components: DateRangeCalendar githubLabel: 'component: DateRangePicker' diff --git a/docs/data/date-pickers/date-range-field/date-range-field.md b/docs/data/date-pickers/date-range-field/date-range-field.md index bc3eb0a9c424..ff5ffcc86519 100644 --- a/docs/data/date-pickers/date-range-field/date-range-field.md +++ b/docs/data/date-pickers/date-range-field/date-range-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Range Field components components: MultiInputDateRangeField, SingleInputDateRangeField githubLabel: 'component: pickers' 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 942173ec1d7d..ecde5f529b3e 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 @@ --- +productId: x-date-pickers title: React Date Range Picker component components: DateRangePicker, DesktopDateRangePicker, MobileDateRangePicker, StaticDateRangePicker, DateRangeCalendar, DateRangePickerDay githubLabel: 'component: DateRangePicker' diff --git a/docs/data/date-pickers/date-time-field/date-time-field.md b/docs/data/date-pickers/date-time-field/date-time-field.md index e57133792568..4b541b8ab294 100644 --- a/docs/data/date-pickers/date-time-field/date-time-field.md +++ b/docs/data/date-pickers/date-time-field/date-time-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Field component components: DateTimeField githubLabel: 'component: pickers' 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 4dc8ceed96dd..f65cf61a8e77 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 @@ --- +productId: x-date-pickers title: React Date Time Picker component components: DateTimePicker, DesktopDateTimePicker, MobileDateTimePicker, StaticDateTimePicker githubLabel: 'component: DateTimePicker' diff --git a/docs/data/date-pickers/date-time-range-field/date-time-range-field.md b/docs/data/date-pickers/date-time-range-field/date-time-range-field.md index dc9063e0b686..7656e96a5c21 100644 --- a/docs/data/date-pickers/date-time-range-field/date-time-range-field.md +++ b/docs/data/date-pickers/date-time-range-field/date-time-range-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Time Range Field components components: MultiInputDateTimeRangeField, SingleInputDateTimeRangeField githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/date-time-range-picker/date-time-range-picker.md b/docs/data/date-pickers/date-time-range-picker/date-time-range-picker.md index ac3e07fb4e70..a6c34b2c2632 100644 --- a/docs/data/date-pickers/date-time-range-picker/date-time-range-picker.md +++ b/docs/data/date-pickers/date-time-range-picker/date-time-range-picker.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Time Range Picker component githubLabel: 'component: DateTimeRangePicker' packageName: '@mui/x-date-pickers-pro' diff --git a/docs/data/date-pickers/digital-clock/digital-clock.md b/docs/data/date-pickers/digital-clock/digital-clock.md index 09a428d92918..1da38093b26a 100644 --- a/docs/data/date-pickers/digital-clock/digital-clock.md +++ b/docs/data/date-pickers/digital-clock/digital-clock.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Digital Clock component components: DigitalClock, MultiSectionDigitalClock githubLabel: 'component: TimePicker' diff --git a/docs/data/date-pickers/fields/fields.md b/docs/data/date-pickers/fields/fields.md index 11df5ac65169..85fbff5ebe47 100644 --- a/docs/data/date-pickers/fields/fields.md +++ b/docs/data/date-pickers/fields/fields.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Date Fields components components: DateField, TimeField, DateTimeField, MultiInputDateRangeField, SingleInputDateRangeField, MultiInputTimeRangeField, SingleInputTimeRangeField, MultiInputDateTimeRangeField, SingleInputDateTimeRangeField githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/getting-started/getting-started.md b/docs/data/date-pickers/getting-started/getting-started.md index 50038331bb1a..7f771395d20c 100644 --- a/docs/data/date-pickers/getting-started/getting-started.md +++ b/docs/data/date-pickers/getting-started/getting-started.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time Picker - Getting started packageName: '@mui/x-date-pickers' githubLabel: 'component: pickers' @@ -27,13 +28,14 @@ take a look at the [dedicated section](/x/react-date-pickers/#date-library) The Date and Time Pickers package has a peer dependency on `@mui/material`. If you are not already using it in your project, you can install it with: -```sh -// with npm + +```bash npm npm install @mui/material @emotion/react @emotion/styled - -// with yarn +``` +```bash yarn yarn add @mui/material @emotion/react @emotion/styled ``` + @@ -50,14 +52,17 @@ Please note that [react](https://www.npmjs.com/package/react) and [react-dom](ht Material UI is using [Emotion](https://emotion.sh/docs/introduction) as a styling engine by default. If you want to use [`styled-components`](https://styled-components.com/) instead, run: -```sh -// with npm + +```bash npm npm install @mui/styled-engine-sc styled-components +``` -// with yarn +```bash yarn yarn add @mui/styled-engine-sc styled-components ``` + + 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. ## Setup your date library adapter diff --git a/docs/data/date-pickers/lifecycle/lifecycle.md b/docs/data/date-pickers/lifecycle/lifecycle.md index f155722544d7..5f23accfc578 100644 --- a/docs/data/date-pickers/lifecycle/lifecycle.md +++ b/docs/data/date-pickers/lifecycle/lifecycle.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Components lifecycle githubLabel: 'component: pickers' packageName: '@mui/x-date-pickers' diff --git a/docs/data/date-pickers/localization/localization.md b/docs/data/date-pickers/localization/localization.md index 89b2ff6baf2e..b459466a8b25 100644 --- a/docs/data/date-pickers/localization/localization.md +++ b/docs/data/date-pickers/localization/localization.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time Pickers - Component localization components: LocalizationProvider githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/overview/overview.md b/docs/data/date-pickers/overview/overview.md index c245407b5785..c444f4a1adc1 100644 --- a/docs/data/date-pickers/overview/overview.md +++ b/docs/data/date-pickers/overview/overview.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time Picker React components packageName: '@mui/x-date-pickers' githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/shortcuts/shortcuts.md b/docs/data/date-pickers/shortcuts/shortcuts.md index 45290b31e5ac..74550b01fe0e 100644 --- a/docs/data/date-pickers/shortcuts/shortcuts.md +++ b/docs/data/date-pickers/shortcuts/shortcuts.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - Shortcuts components: PickersShortcuts --- diff --git a/docs/data/date-pickers/time-clock/time-clock.md b/docs/data/date-pickers/time-clock/time-clock.md index c90d33daeee4..d9d9ba1501bb 100644 --- a/docs/data/date-pickers/time-clock/time-clock.md +++ b/docs/data/date-pickers/time-clock/time-clock.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Time Clock component components: TimeClock githubLabel: 'component: TimePicker' diff --git a/docs/data/date-pickers/time-field/time-field.md b/docs/data/date-pickers/time-field/time-field.md index d6e2329f5b72..e6e7218b0095 100644 --- a/docs/data/date-pickers/time-field/time-field.md +++ b/docs/data/date-pickers/time-field/time-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Time Field component components: TimeField githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/time-picker/time-picker.md b/docs/data/date-pickers/time-picker/time-picker.md index 1a80e5b9fb62..f1614a951ab9 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 @@ --- +productId: x-date-pickers title: React Time Picker component components: TimePicker, DesktopTimePicker, MobileTimePicker, StaticTimePicker githubLabel: 'component: TimePicker' diff --git a/docs/data/date-pickers/time-range-field/time-range-field.md b/docs/data/date-pickers/time-range-field/time-range-field.md index f2b36ed6eb5a..24376e993228 100644 --- a/docs/data/date-pickers/time-range-field/time-range-field.md +++ b/docs/data/date-pickers/time-range-field/time-range-field.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Time Range Field components components: MultiInputTimeRangeField, SingleInputTimeRangeField githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/time-range-picker/time-range-picker.md b/docs/data/date-pickers/time-range-picker/time-range-picker.md index c55c8052fe33..f2c74a19f251 100644 --- a/docs/data/date-pickers/time-range-picker/time-range-picker.md +++ b/docs/data/date-pickers/time-range-picker/time-range-picker.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: React Time Range Picker component githubLabel: 'component: TimeRangePicker' packageName: '@mui/x-date-pickers-pro' diff --git a/docs/data/date-pickers/timezone/timezone.md b/docs/data/date-pickers/timezone/timezone.md index 5a16f38366c3..d6d98068b96f 100644 --- a/docs/data/date-pickers/timezone/timezone.md +++ b/docs/data/date-pickers/timezone/timezone.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers title: Date and Time pickers - UTC and timezones components: LocalizationProvider githubLabel: 'component: pickers' diff --git a/docs/data/date-pickers/validation/validation.md b/docs/data/date-pickers/validation/validation.md index 6010acd3532f..4116308df95d 100644 --- a/docs/data/date-pickers/validation/validation.md +++ b/docs/data/date-pickers/validation/validation.md @@ -1,4 +1,5 @@ --- +productId: x-date-pickers components: DatePicker, DesktopDatePicker, MobileDatePicker, StaticDatePicker, TimePicker, DesktopTimePicker, MobileTimePicker, StaticTimePicker, DateTimePicker, DesktopDateTimePicker, MobileDateTimePicker, StaticDateTimePicker, DateRangePicker, DesktopDateRangePicker, MobileDateRangePicker, StaticDateRangePicker githubLabel: 'component: pickers' packageName: '@mui/x-date-pickers' diff --git a/docs/data/migration/migration-data-grid-v5/migration-data-grid-v5.md b/docs/data/migration/migration-data-grid-v5/migration-data-grid-v5.md index d5409e0c8ed8..b620d90d62e8 100644 --- a/docs/data/migration/migration-data-grid-v5/migration-data-grid-v5.md +++ b/docs/data/migration/migration-data-grid-v5/migration-data-grid-v5.md @@ -31,7 +31,7 @@ The `preset-safe` codemod will automatically adjust the bulk of your code to acc You can either run it on a specific file, folder, or your entire codebase when choosing the `` argument. -```sh +```bash // Data Grid specific npx @mui/x-codemod v6.0.0/data-grid/preset-safe // Target Date and Time pickers as well @@ -495,7 +495,7 @@ To smooth the transition, data grid support both the `components` props which ar If you would like to use the new API and do not want to see deprecated prop usage, consider running `rename-components-to-slots` codemod handling the prop renaming. -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/rename-components-to-slots ``` diff --git a/docs/data/migration/migration-pickers-lab/migration-pickers-lab.md b/docs/data/migration/migration-pickers-lab/migration-pickers-lab.md index 2961155c5311..eeabe3095b22 100644 --- a/docs/data/migration/migration-pickers-lab/migration-pickers-lab.md +++ b/docs/data/migration/migration-pickers-lab/migration-pickers-lab.md @@ -31,24 +31,30 @@ If you already have a license for `@mui/x-data-grid-pro`, you can use the same o #### Community Plan -```sh -// with npm + +```bash npm npm install @mui/x-date-pickers +``` -// with yarn +```bash yarn yarn add @mui/x-date-pickers ``` + + #### Pro Plan -```sh -// with npm + +```bash npm npm install @mui/x-date-pickers-pro @mui/x-license-pro +``` -// with yarn +```bash yarn yarn add @mui/x-date-pickers-pro @mui/x-license-pro ``` + + When you purchase a commercial license, you'll receive a license key by email. You must set the license key before rendering the first component. @@ -66,7 +72,7 @@ We have prepared a codemod to help you migrate your codebase. You can either run it on a specific file, folder, or your entire codebase when choosing the `` argument. -```sh +```bash npx @mui/codemod v5.0.0/date-pickers-moved-to-x ``` diff --git a/docs/data/migration/migration-pickers-v5/migration-pickers-v5.md b/docs/data/migration/migration-pickers-v5/migration-pickers-v5.md index a99aae74e863..c151770e5e0b 100644 --- a/docs/data/migration/migration-pickers-v5/migration-pickers-v5.md +++ b/docs/data/migration/migration-pickers-v5/migration-pickers-v5.md @@ -31,7 +31,7 @@ The `preset-safe` codemod will automatically adjust the bulk of your code to acc You can either run it on a specific file, folder, or your entire codebase when choosing the `` argument. -```sh +```bash // Date and Time Pickers specific npx @mui/x-codemod v6.0.0/pickers/preset-safe // Target Data Grid as well @@ -958,7 +958,7 @@ To smooth the transition, pickers support both the `components` props which are If you would like to use the new API and do not want to see deprecated prop usage, consider running `rename-components-to-slots` codemod handling the prop renaming. -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/rename-components-to-slots ``` diff --git a/docs/src/modules/components/InstallationInstructions.tsx b/docs/src/modules/components/InstallationInstructions.tsx index 3006504c75bc..1f3fd737d2df 100644 --- a/docs/src/modules/components/InstallationInstructions.tsx +++ b/docs/src/modules/components/InstallationInstructions.tsx @@ -104,7 +104,7 @@ export default function InstallationInstructions(props: { ) : null} - + ); } diff --git a/packages/grid/x-data-grid-premium/README.md b/packages/grid/x-data-grid-premium/README.md index d245ad14d0cf..bb75943346dd 100644 --- a/packages/grid/x-data-grid-premium/README.md +++ b/packages/grid/x-data-grid-premium/README.md @@ -7,7 +7,7 @@ It's part of MUI X, an open core extension of MUI, with advanced components. Install the package in your project directory with: -```sh +```bash // with npm npm install @mui/x-data-grid-premium diff --git a/packages/grid/x-data-grid-pro/README.md b/packages/grid/x-data-grid-pro/README.md index 460ca094b512..7848dcdd4b6d 100644 --- a/packages/grid/x-data-grid-pro/README.md +++ b/packages/grid/x-data-grid-pro/README.md @@ -7,7 +7,7 @@ It's part of MUI X, an open core extension of MUI, with advanced components. Install the package in your project directory with: -```sh +```bash // with npm npm install @mui/x-data-grid-pro diff --git a/packages/grid/x-data-grid/README.md b/packages/grid/x-data-grid/README.md index 20bb12ca25dc..6bd379574b8f 100644 --- a/packages/grid/x-data-grid/README.md +++ b/packages/grid/x-data-grid/README.md @@ -7,7 +7,7 @@ It's part of MUI X, an open core extension of MUI, with advanced components. Install the package in your project directory with: -```sh +```bash // with npm npm install @mui/x-data-grid diff --git a/packages/x-charts/README.md b/packages/x-charts/README.md index 2a024445328b..4cece62a408f 100644 --- a/packages/x-charts/README.md +++ b/packages/x-charts/README.md @@ -7,13 +7,13 @@ It's part of MUI X, an open-core extension of MUI, with advanced components. Install the package in your project directory with: -```sh +```bash npm install @mui/x-charts ``` or -```sh +```bash yarn add @mui/x-charts ``` diff --git a/packages/x-codemod/README.md b/packages/x-codemod/README.md index a38a86a400ad..a4abb6498bea 100644 --- a/packages/x-codemod/README.md +++ b/packages/x-codemod/README.md @@ -38,7 +38,7 @@ Examples: To pass more options directly to jscodeshift, use `--jscodeshift=...`. For example: -```sh +```bash // single option npx @mui/x-codemod --jscodeshift=--run-in-band // multiple options @@ -52,7 +52,7 @@ See all available options [here](https://github.com/facebook/jscodeshift#usage-c Options to [recast](https://github.com/benjamn/recast)'s printer can be provided through jscodeshift's `printOptions` command line argument -```sh +```bash npx @mui/x-codemod --jscodeshift="--printOptions='{\"quote\":\"double\"}'" ``` @@ -64,7 +64,7 @@ npx @mui/x-codemod --jscodeshift="--printOptions='{\"quote\": A combination of all important transformers for migrating v5 to v6. ⚠️ This codemod should be run only once. It runs codemods for both Data Grid and Date and Time Pickers packages. To run codemods for a specific package, refer to the respective section. -```sh +```bash npx @mui/x-codemod v6.0.0/preset-safe ``` @@ -79,7 +79,7 @@ The corresponding sub-sections are listed below The `preset-safe` codemods for pickers. -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/preset-safe ``` @@ -164,7 +164,7 @@ Renames the `locale` prop of the `LocalizationProvider` component into `adapterL ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/localization-provider-rename-locale ``` @@ -181,7 +181,7 @@ Replace props used for localization such as `cancelText` to their corresponding /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/text-props-to-localeText ``` @@ -222,7 +222,7 @@ Replace props used for `Tabs` in DateTime pickers by `componentsProps.tabs` prop /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/replace-tabs-props ``` @@ -248,7 +248,7 @@ Replace props used to customize the `Toolbar` in pickers by slots properties and + localeText={{ toolbarTitle: "Title" }} ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/replace-toolbar-props-by-slot ``` @@ -298,7 +298,7 @@ Replace customization props by their equivalent `components` and `componentsProp /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/migrate-to-components-componentsProps ``` @@ -324,7 +324,7 @@ Replace `LeftArrowButton` and `RightArrowButton` slots for navigation buttons by /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/replace-arrows-button-slot ``` @@ -339,7 +339,7 @@ Replace `shouldDisableTime` by `shouldDisableClock`. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/rename-should-disable-time ``` @@ -354,7 +354,7 @@ Replace `inputFormat` prop with `format`. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/rename-inputFormat-prop ``` @@ -377,7 +377,7 @@ Rename toolbar related translation keys, removing `Default` part from them to be /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/rename-default-toolbar-title-localeText ``` @@ -396,7 +396,7 @@ This change only affects pickers components. />; ``` -```sh +```bash npx @mui/x-codemod v6.0.0/pickers/rename-components-to-slots ``` @@ -406,7 +406,7 @@ npx @mui/x-codemod v6.0.0/pickers/rename-components-to-slots The `preset-safe` codemods for data grid. -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/preset-safe ``` @@ -441,7 +441,7 @@ Replace column menu items that have been renamed. ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/column-menu-components-rename ``` @@ -468,7 +468,7 @@ Data grid props that have been renamed. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/row-selection-props-rename ``` @@ -483,7 +483,7 @@ Rename `rowsPerPageOptions` prop to `pageSizeOptions`. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/rename-rowsPerPageOptions-prop ``` @@ -497,7 +497,7 @@ Remove `disableExtendRowFullWidth` prop which is no longer supported. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/remove-disableExtendRowFullWidth-prop ``` @@ -552,7 +552,7 @@ Rename `linkOperators` related props to `logicOperators` and rename classes. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/rename-linkOperators-logicOperators ``` @@ -593,7 +593,7 @@ Rename filter item props to the new values. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/rename-filter-item-props ``` @@ -632,7 +632,7 @@ Rename selectors and events. } ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/rename-selectors-and-events ``` @@ -657,7 +657,7 @@ Remove feature flags for stabilized `experimentalFeatures`. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/remove-stabilized-experimentalFeatures ``` @@ -676,7 +676,7 @@ Replace `onCellFocusOut` prop with `componentsProps.cell.onBlur`. /> ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/replace-onCellFocusOut-prop ``` @@ -695,7 +695,7 @@ This change only affects data grid components. />; ``` -```sh +```bash npx @mui/x-codemod v6.0.0/data-grid/rename-components-to-slots ``` diff --git a/packages/x-date-pickers-pro/README.md b/packages/x-date-pickers-pro/README.md index c6914bdd8674..5fe6e0a6e55c 100644 --- a/packages/x-date-pickers-pro/README.md +++ b/packages/x-date-pickers-pro/README.md @@ -7,7 +7,7 @@ It's part of MUI X, an open-core extension of MUI, with advanced components. Install the package in your project directory with: -```sh +```bash npm install @mui/x-date-pickers-pro ``` @@ -19,7 +19,7 @@ We currently support 4 different date libraries: - [Luxon](https://moment.github.io/luxon/#/) - [Moment.js](https://momentjs.com/) -```sh +```bash // date-fns npm install date-fns // or dayjs diff --git a/packages/x-date-pickers/README.md b/packages/x-date-pickers/README.md index 69fd8bc0ff53..f0aa61366656 100644 --- a/packages/x-date-pickers/README.md +++ b/packages/x-date-pickers/README.md @@ -7,7 +7,7 @@ It's part of MUI X, an open-core extension of MUI, with advanced components. Install the package in your project directory with: -```sh +```bash npm install @mui/x-date-pickers ``` @@ -19,7 +19,7 @@ We currently support 4 different date libraries: - [Luxon](https://moment.github.io/luxon/#/) - [Moment.js](https://momentjs.com/) -```sh +```bash // date-fns npm install date-fns // or dayjs diff --git a/scripts/README.md b/scripts/README.md index 28df9f9ffd84..9a9a674f1c9e 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -46,7 +46,7 @@ The documentation must be updated on the `docs-vX` branch (`docs-v4` for `v4.X` -```sh +```bash git push upstream master:docs-v6 -f ``` diff --git a/yarn.lock b/yarn.lock index f2d2d69aa53b..1a0cf8b65681 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1876,8 +1876,8 @@ react-transition-group "^4.4.5" "@mui/monorepo@https://github.com/mui/material-ui.git#master": - version "5.13.6" - resolved "https://github.com/mui/material-ui.git#e6f223acbd826cccb130d7f8af543bb40251754e" + version "5.13.7" + resolved "https://github.com/mui/material-ui.git#ab2cb8cf9614ccab02b62a22de5129a1c2774d96" "@mui/private-theming@^5.13.1": version "5.13.1"