Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for v6 stable release #43454

Merged
merged 14 commits into from
Aug 27, 2024
Merged
Prev Previous commit
Next Next commit
Remove few other next occurences
mnajdova committed Aug 27, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 86aea1d321bff89d9dab24d75eea9b2055400b0e
2 changes: 1 addition & 1 deletion examples/material-ui-pigment-css-nextjs-ts/README.md
Original file line number Diff line number Diff line change
@@ -42,4 +42,4 @@ To learn more about this example:
<!-- #default-branch-switch -->

You now have a working example project.
You can head back to the documentation and continue by browsing the [templates](https://next.mui.com/material-ui/getting-started/templates/) section.
You can head back to the documentation and continue by browsing the [templates](https://mui.com/material-ui/getting-started/templates/) section.
2 changes: 1 addition & 1 deletion examples/material-ui-pigment-css-vite-ts/README.md
Original file line number Diff line number Diff line change
@@ -36,4 +36,4 @@ It includes `@mui/material` and [Pigment CSS](https://github.com/mui/pigment-cs
<!-- #default-branch-switch -->

You now have a working example project.
You can head back to the documentation and continue by browsing the [templates](https://next.mui.com/material-ui/getting-started/templates/) section.
You can head back to the documentation and continue by browsing the [templates](https://mui.com/material-ui/getting-started/templates/) section.
4 changes: 2 additions & 2 deletions packages/mui-material/src/Badge/useBadge.ts
Original file line number Diff line number Diff line change
@@ -7,11 +7,11 @@ import { UseBadgeParameters, UseBadgeReturnValue } from './useBadge.types';
*
* Demos:
*
* - [Badge](https://next.mui.com/base-ui/react-badge/#hook)
* - [Badge](https://mui.com/base-ui/react-badge/#hook)
*
* API:
*
* - [useBadge API](https://next.mui.com/base-ui/react-badge/hooks-api/#use-badge)
* - [useBadge API](https://mui.com/base-ui/react-badge/hooks-api/#use-badge)
*/
function useBadge(parameters: UseBadgeParameters): UseBadgeReturnValue {
const {
2 changes: 1 addition & 1 deletion packages/mui-material/src/Grid/Grid.d.ts
Original file line number Diff line number Diff line change
@@ -168,7 +168,7 @@ export interface GridTypeMap<
*
* - [Grid API](https://mui.com/material-ui/api/grid/)
*
* @deprecated Use the [`Grid2`](https://next.mui.com/material-ui/react-grid2/) component instead.
* @deprecated Use the [`Grid2`](https://mui.com/material-ui/react-grid2/) component instead.
*/
declare const Grid: OverridableComponent<GridTypeMap>;

2 changes: 1 addition & 1 deletion packages/mui-material/src/Grid/Grid.js
Original file line number Diff line number Diff line change
@@ -399,7 +399,7 @@ const useUtilityClasses = (ownerState) => {
};

/**
* @deprecated Use the [`Grid2`](https://next.mui.com/material-ui/react-grid2/) component instead.
* @deprecated Use the [`Grid2`](https://mui.com/material-ui/react-grid2/) component instead.
*/
const Grid = React.forwardRef(function Grid(inProps, ref) {
const themeProps = useThemeProps({ props: inProps, name: 'MuiGrid' });
4 changes: 2 additions & 2 deletions packages/mui-material/src/Modal/useModal.ts
Original file line number Diff line number Diff line change
@@ -31,11 +31,11 @@ const defaultManager = new ModalManager();
*
* Demos:
*
* - [Modal](https://next.mui.com/base-ui/react-modal/#hook)
* - [Modal](https://mui.com/base-ui/react-modal/#hook)
*
* API:
*
* - [useModal API](https://next.mui.com/base-ui/react-modal/hooks-api/#use-modal)
* - [useModal API](https://mui.com/base-ui/react-modal/hooks-api/#use-modal)
*/
function useModal(parameters: UseModalParameters): UseModalReturnValue {
const {
4 changes: 2 additions & 2 deletions packages/mui-material/src/Slider/useSlider.ts
Original file line number Diff line number Diff line change
@@ -192,11 +192,11 @@ function doesSupportTouchActionNone() {
*
* Demos:
*
* - [Slider](https://next.mui.com/base-ui/react-slider/#hook)
* - [Slider](https://mui.com/base-ui/react-slider/#hook)
*
* API:
*
* - [useSlider API](https://next.mui.com/base-ui/react-slider/hooks-api/#use-slider)
* - [useSlider API](https://mui.com/base-ui/react-slider/hooks-api/#use-slider)
*/
export function useSlider(parameters: UseSliderParameters): UseSliderReturnValue {
const {
4 changes: 2 additions & 2 deletions packages/mui-material/src/Snackbar/useSnackbar.ts
Original file line number Diff line number Diff line change
@@ -17,11 +17,11 @@ import { EventHandlers } from '../utils/types';
*
* Demos:
*
* - [Snackbar](https://next.mui.com/base-ui/react-snackbar/#hook)
* - [Snackbar](https://mui.com/base-ui/react-snackbar/#hook)
*
* API:
*
* - [useSnackbar API](https://next.mui.com/base-ui/react-snackbar/hooks-api/#use-snackbar)
* - [useSnackbar API](https://mui.com/base-ui/react-snackbar/hooks-api/#use-snackbar)
*/
function useSnackbar(parameters: UseSnackbarParameters = {}): UseSnackbarReturnValue {
const {
Original file line number Diff line number Diff line change
@@ -347,11 +347,11 @@ export type AutocompleteGetTagProps = ({ index }: { index: number }) => {
*
* Demos:
*
* - [Autocomplete](https://next.mui.com/base-ui/react-autocomplete/#hook)
* - [Autocomplete](https://mui.com/base-ui/react-autocomplete/#hook)
*
* API:
*
* - [useAutocomplete API](https://next.mui.com/base-ui/react-autocomplete/hooks-api/#use-autocomplete)
* - [useAutocomplete API](https://mui.com/base-ui/react-autocomplete/hooks-api/#use-autocomplete)
*/
export function useAutocomplete<
Value,

Unchanged files with check annotations Beta

## Examples
Our documentation features [a collection of example projects using Base UI](https://github.com/mui/material-ui/tree/master/examples).

Check warning on line 31 in packages/mui-base/README.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'Our'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'Our'.", "location": {"path": "packages/mui-base/README.md", "range": {"start": {"line": 31, "column": 1}}}, "severity": "WARNING"}
## Contributing
**Note:** This example is set up to use the Next.js Pages Router.
As of Next.js 13.4, the newer App Router pattern is stable.
We recommend starting new projects with the [Material UI with Next.js (App Router) example](https://github.com/mui/material-ui/tree/master/examples/material-ui-nextjs) unless you need (or prefer) the Pages Router.

Check warning on line 33 in examples/material-ui-nextjs-pages-router/README.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'We'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "examples/material-ui-nextjs-pages-router/README.md", "range": {"start": {"line": 33, "column": 1}}}, "severity": "WARNING"}
The project uses [Next.js](https://github.com/vercel/next.js), which is a framework for server-rendered React apps.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
**Note:** This example is set up to use the Next.js Pages Router.
As of Next.js 13.4, the newer App Router pattern is stable.
We recommend starting new projects with the [Material UI with Next.js (App Router) example](https://github.com/mui/material-ui/tree/master/examples/material-ui-nextjs-ts) unless you need (or prefer) the Pages Router.

Check warning on line 33 in examples/material-ui-nextjs-pages-router-ts/README.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'We'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "examples/material-ui-nextjs-pages-router-ts/README.md", "range": {"start": {"line": 33, "column": 1}}}, "severity": "WARNING"}
The project uses [Next.js](https://github.com/vercel/next.js), which is a framework for server-rendered React apps.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
<!-- #default-branch-switch -->
- 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.

Check warning on line 149 in CONTRIBUTING.md

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Google.We] Try to avoid using first-person plural like 'We'. Raw Output: {"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "CONTRIBUTING.md", "range": {"start": {"line": 149, "column": 225}}}, "severity": "WARNING"}
- 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.