Skip to content

Commit

Permalink
Prepare for v6 stable release (#43454)
Browse files Browse the repository at this point in the history
siriwatknp authored Aug 27, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent ea49b9f commit 46bac33
Showing 265 changed files with 884 additions and 966 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -142,7 +142,7 @@ jobs:
name: '`pnpm dedupe` was run?'
command: |
# #default-branch-switch
if [[ $(git diff --name-status next | grep -E 'pnpm-workspace\.yaml|pnpm-lock.yaml|package\.json') == "" ]];
if [[ $(git diff --name-status master | grep -E 'pnpm-workspace\.yaml|pnpm-lock.yaml|package\.json') == "" ]];
then
echo "No changes to dependencies detected. Skipping..."
else
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -72,11 +72,11 @@ git remote add upstream https://github.com/mui/material-ui.git

<!-- #default-branch-switch -->

3. Synchronize your local `next` branch with the upstream one:
3. Synchronize your local `master` branch with the upstream one:

```bash
git checkout next
git pull upstream next
git checkout master
git pull upstream master
```

4. Install the dependencies with pnpm (yarn or npm aren't supported):
@@ -146,7 +146,7 @@ Make sure the following is true:

<!-- #default-branch-switch -->

- The branch is targeted at `next` for ongoing development. All tests are passing. Code that lands in `next` must be compatible with the latest alpha/beta release. It may contain additional features but no breaking changes. We should be able to release a new minor version from the tip of `next` at any time.
- The branch is targeted at `master` for ongoing development. All tests are passing. Code that lands in `master` must be compatible with the latest stable release. It may contain additional features but no breaking changes. We should be able to release a new minor version from the tip of `master` at any time.
- If a feature is being added:
- If the result was already achievable with the core library, you've explained why this feature needs to be added to the core.
- If this is a common use case, you've added an example to the documentation.
12 changes: 3 additions & 9 deletions docs/data/base/getting-started/quickstart/quickstart.md
Original file line number Diff line number Diff line change
@@ -10,24 +10,18 @@ If you're using Next.js 13.4 or later, check out the [Next.js App Router guide](

`@mui/base` is completely standalone – run one of the following commands to add Base UI to your React project:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

<codeblock storageKey="package-manager">

```bash npm
npm install @mui/base@next
npm install @mui/base
```

```bash pnpm
pnpm add @mui/base@next
pnpm add @mui/base
```

```bash yarn
yarn add @mui/base@next
yarn add @mui/base
```

</codeblock>
Original file line number Diff line number Diff line change
@@ -31,14 +31,8 @@ We'll use [`create-react-app` with TypeScript](https://create-react-app.dev/docs
After you have created the project, follow the instructions given on the [Tailwind CSS installation page](https://tailwindcss.com/docs/guides/create-react-app) in order to configure `tailwind`.
Next, install `@mui/base` in the project:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

```bash
npm install @mui/base@next
npm install @mui/base
```

## Adding the player markup
12 changes: 3 additions & 9 deletions docs/data/joy/getting-started/installation/installation.md
Original file line number Diff line number Diff line change
@@ -6,24 +6,18 @@

Run one of the following commands to add Joy UI to your project:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

<codeblock storageKey="package-manager">

```bash npm
npm install @mui/joy@next @emotion/react @emotion/styled
npm install @mui/joy @emotion/react @emotion/styled
```

```bash pnpm
pnpm add @mui/joy@next @emotion/react @emotion/styled
pnpm add @mui/joy @emotion/react @emotion/styled
```

```bash yarn
yarn add @mui/joy@next @emotion/react @emotion/styled
yarn add @mui/joy @emotion/react @emotion/styled
```

</codeblock>
14 changes: 2 additions & 12 deletions docs/data/joy/integrations/icon-libraries/icon-libraries.md
Original file line number Diff line number Diff line change
@@ -13,12 +13,8 @@ This section assumes that you've already installed Joy UI in your app—see [In

#### yarn

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

```bash
yarn add @mui/icons-material@next @mui/material@next
yarn add @mui/icons-material @mui/material
```

:::warning
@@ -43,14 +39,8 @@ You can keep track of the progress in [this issue](https://github.com/mui/materi

#### npm

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

```bash
npm install @mui/icons-material@next @mui/material@next
npm install @mui/icons-material @mui/material
```

:::warning
10 changes: 3 additions & 7 deletions docs/data/material/components/about-the-lab/about-the-lab.md
Original file line number Diff line number Diff line change
@@ -19,24 +19,20 @@ For a component to be ready to move to the core, the following criteria are cons

To install and save in your `package.json` dependencies, run one of the following commands:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

<codeblock storageKey="package-manager">

```bash npm
npm install @mui/lab@next @mui/material@next
npm install @mui/lab @mui/material
```

```bash pnpm
pnpm add @mui/lab@next @mui/material@next
pnpm add @mui/lab @mui/material
```

```bash yarn
yarn add @mui/lab@next @mui/material@next
yarn add @mui/lab @mui/material
```

</codeblock>
10 changes: 3 additions & 7 deletions docs/data/material/components/icons/icons.md
Original file line number Diff line number Diff line change
@@ -26,23 +26,19 @@ You can [search the full list of these icons](/material-ui/material-icons/).

Run one of the following commands to install it and save it to your `package.json` dependencies:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

<codeblock storageKey="package-manager">
```bash npm
npm install @mui/icons-material@next
npm install @mui/icons-material
```

```bash pnpm
pnpm add @mui/icons-material@next
pnpm add @mui/icons-material
```

```bash yarn
yarn add @mui/icons-material@next
yarn add @mui/icons-material
```

</codeblock>
10 changes: 3 additions & 7 deletions docs/data/material/components/material-icons/material-icons.md
Original file line number Diff line number Diff line change
@@ -18,24 +18,20 @@ includes the 2,100+ official [Material Icons](https://fonts.google.com/icons?ico
It depends on `@mui/material`, which requires Emotion packages.
Use one of the following commands to install it:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

<codeblock storageKey="package-manager">

```bash npm
npm install @mui/icons-material@next @mui/material@next @emotion/styled @emotion/react
npm install @mui/icons-material @mui/material @emotion/styled @emotion/react
```

```bash pnpm
pnpm add @mui/icons-material@next @mui/material@next @emotion/styled @emotion/react
pnpm add @mui/icons-material @mui/material @emotion/styled @emotion/react
```

```bash yarn
yarn add @mui/icons-material@next @mui/material@next @emotion/styled @emotion/react
yarn add @mui/icons-material @mui/material @emotion/styled @emotion/react
```

</codeblock>
6 changes: 3 additions & 3 deletions docs/data/material/customization/dark-mode/dark-mode.md
Original file line number Diff line number Diff line change
@@ -198,9 +198,9 @@ We provide codemods to migrate your codebase from using `theme.palette.mode` to
You can run each codemod below or all of them at once.

```bash
npx @mui/codemod@next v6.0.0/styled <path/to/folder-or-file>
npx @mui/codemod@next v6.0.0/sx-prop <path/to/folder-or-file>
npx @mui/codemod@next v6.0.0/theme-v6 <path/to/theme-file>
npx @mui/codemod@latest v6.0.0/styled <path/to/folder-or-file>
npx @mui/codemod@latest v6.0.0/sx-prop <path/to/folder-or-file>
npx @mui/codemod@latest v6.0.0/theme-v6 <path/to/theme-file>
```

> Run `v6.0.0/theme-v6` against the file that contains the custom `styleOverrides`. Ignore this codemod if you don't have a custom theme.
12 changes: 4 additions & 8 deletions docs/data/material/getting-started/installation/installation.md
Original file line number Diff line number Diff line change
@@ -6,24 +6,20 @@

Run one of the following commands to add Material UI to your project:

:::info
The `next` tag is used to download the latest <b>pre-release</b>, v6 version. Remove it to get the current stable version.
:::

<!-- #default-branch-switch -->

<codeblock storageKey="package-manager">

```bash npm
npm install @mui/material@next @emotion/react @emotion/styled
npm install @mui/material @emotion/react @emotion/styled
```

```bash pnpm
pnpm add @mui/material@next @emotion/react @emotion/styled
pnpm add @mui/material @emotion/react @emotion/styled
```

```bash yarn
yarn add @mui/material@next @emotion/react @emotion/styled
yarn add @mui/material @emotion/react @emotion/styled
```

</codeblock>
@@ -162,7 +158,7 @@ You can start using Material UI right away with minimal front-end infrastructur

<!-- #default-branch-switch -->

Follow [this CDN example](https://github.com/mui/material-ui/tree/next/examples/material-ui-via-cdn) to get started.
Follow [this CDN example](https://github.com/mui/material-ui/tree/master/examples/material-ui-via-cdn) to get started.

:::error
We do _not_ recommend using this approach in production.
4 changes: 2 additions & 2 deletions docs/data/material/getting-started/templates/blog/README.md
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react, markdown-to-jsx.
3. Import and use the `Blog` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/blog/.
View the demo at https://mui.com/material-ui/getting-started/templates/blog/.
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @emotion/styled, @emotion/react.
3. Import and use the `Checkout` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/checkout/.
View the demo at https://mui.com/material-ui/getting-started/templates/checkout/.
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react, @mui/x-charts.
3. Import and use the `Dashboard` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/dashboard/.
View the demo at https://mui.com/material-ui/getting-started/templates/dashboard/.
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
3. Import and use the `MarketingPage` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/marketing-page/.
View the demo at https://mui.com/material-ui/getting-started/templates/marketing-page/.
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
3. Import and use the `SignInSide` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/sign-in-side/.
View the demo at https://mui.com/material-ui/getting-started/templates/sign-in-side/.
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
3. Import and use the `SignIn` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/sign-in/.
View the demo at https://mui.com/material-ui/getting-started/templates/sign-in/.
Original file line number Diff line number Diff line change
@@ -4,12 +4,12 @@

<!-- #default-branch-switch -->

1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/next/examples).
1. Copy the files into your project, or one of the [example projects](https://github.com/mui/material-ui/tree/master/examples).
2. Make sure your project has the required dependencies: @mui/material, @mui/icons-material, @emotion/styled, @emotion/react.
3. Import and use the `SignUp` component.

## Demo

<!-- #default-branch-switch -->

View the demo at https://next.mui.com/material-ui/getting-started/templates/sign-up/.
View the demo at https://mui.com/material-ui/getting-started/templates/sign-up/.
2 changes: 1 addition & 1 deletion docs/data/material/guides/localization/localization.md
Original file line number Diff line number Diff line change
@@ -98,7 +98,7 @@ The [Data Grid and Data Grid Pro](/x/react-data-grid/) components have their own

<!-- #default-branch-switch -->

You can [find the source](https://github.com/mui/material-ui/blob/next/packages/mui-material/src/locale/index.ts) in the GitHub repository.
You can [find the source](https://github.com/mui/material-ui/blob/master/packages/mui-material/src/locale/index.ts) in the GitHub repository.

To create your own translation, or to customize the English text, copy this file to your project, make any changes needed and import the locale from there.

2 changes: 1 addition & 1 deletion docs/data/material/guides/typescript/typescript.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@

<!-- #default-branch-switch -->

Material UI requires a minimum version of TypeScript 4.7. Have a look at the [Create React App with TypeScript](https://github.com/mui/material-ui/tree/next/examples/material-ui-cra-ts) example.
Material UI requires a minimum version of TypeScript 4.7. Have a look at the [Create React App with TypeScript](https://github.com/mui/material-ui/tree/master/examples/material-ui-cra-ts) example.

For types to work, it's recommended that you have at least the following options enabled in your `tsconfig.json`:

Loading

0 comments on commit 46bac33

Please sign in to comment.