Skip to content

Commit 26c0b30

Browse files
[docs] Fix more references of MUI Base
1 parent 894dd47 commit 26c0b30

File tree

8 files changed

+32
-30
lines changed

8 files changed

+32
-30
lines changed

docs/data/base/components/autocomplete/autocomplete.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: React Autocomplete hook
44
hooks: useAutocomplete
55
githubLabel: 'component: autocomplete'
66
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/
7+
newName: Combobox
8+
newUrl: https://base-ui.com/react/components/autocomplete
79
---
810

911
# Autocomplete

docs/data/base/components/snackbar/snackbar.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: React Snackbar component and hook
44
components: Snackbar
55
hooks: useSnackbar
66
githubLabel: 'component: snackbar'
7+
newName: Toast
8+
newUrl: https://base-ui.com/react/components/toast
79
---
810

911
# Snackbar

docs/pages/blog/base-ui-2024-plans.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: An exciting year ahead for Base UI
2+
title: An exciting year ahead for MUI Base: Base UI
33
description: The unstyled component library will get a stable release, lots of new components, and even better DX in 2024.
44
date: 2024-02-13T00:00:00.000Z
55
authors: ['danilo-leal', 'michaldudak', 'colmtuite', 'oliviertassinari']
66
tags: ['Base UI', 'Product']
77
manualCard: true
88
---
99

10-
The [story of Base UI](/blog/introducing-base-ui/) began several years ago—long before headless React component libraries skyrocketed in popularity—when we started to imagine a world in which Material UI could exist without Material Design.
10+
The [story of MUI Base](/blog/introducing-base-ui/) began several years ago—long before headless React component libraries skyrocketed in popularity—when we started to imagine a world in which Material UI could exist without Material Design.
1111

1212
We're super excited to share that this dream is becoming a reality!
13-
This year will see a lot of investment in Base UI as we expand the team and focus hard on a stable release (tentatively planned for late 2024), which will come full of new components, features, and improvements.
13+
This year will see a lot of investment in MUI Base as we expand the team and focus hard on a new version (tentatively planned for late 2024), which will come full of new components, features, and improvements.
1414

1515
Let's walk through some of the things we're cooking up.
1616

1717
## A larger set of components
1818

19-
Base UI today offers a modest set of components and hooks, including some slightly more complex ones such as [Autocomplete](/base-ui/react-autocomplete/) and [Number Input](/base-ui/react-number-input/).
19+
MUI Base today offers a modest set of components and hooks, including some slightly more complex ones such as [Autocomplete](/base-ui/react-autocomplete/) and [Number Input](/base-ui/react-number-input/).
2020
However, we're aware that the package is still missing many primitive components that developers would need in order to adopt it for real-world applications.
2121
Fear not, because we're working hard to ship more components with the stable release, including:
2222

@@ -35,7 +35,7 @@ We'd love for you to chime in and help us prioritize, so keep an eye on [the ope
3535

3636
## Improved customization API
3737

38-
Currently, Base UI components can be customized to your heart's content using the `slots` and `slotProps` props.
38+
Currently, MUI Base components can be customized to your heart's content using the `slots` and `slotProps` props.
3939
(Read more about them in the "[Overriding component structure](/base-ui/guides/overriding-component-structure/)" guide.)
4040

4141
```tsx
@@ -75,15 +75,17 @@ They're currently available for use with the Popup, Menu, and Select, and the pl
7575

7676
## Getting many issues out of the way
7777

78-
The core of what Base UI strives to deliver out of the box is first-class accessibility and an intuitive API for extensive customization.
78+
The core of what MUI Base strives to deliver out of the box is first-class accessibility and an intuitive API for extensive customization.
7979
We've earmarked several issues we want to tackle before the stable release in areas such as keyboard navigation, better ARIA support, focus styles, and more.
8080

81-
## A more independent product
81+
## A more independent product: Base UI
8282

83-
So far, all Base UI-related development has happened within the [Material UI GitHub repository](https://github.com/mui/material-ui).
84-
That made a lot of sense in the beginning because we didn't intend for Base UI to be a standalone product at the time.
83+
So far, all MUI Base-related development has happened within the [Material UI GitHub repository](https://github.com/mui/material-ui).
84+
That made a lot of sense in the beginning because we didn't intend for MUI Base to be a standalone product at the time.
8585
As a result of this early decision, we've seen that some developers are hesitant to try it out because of the apparent association with Material Design.
86-
Rest assured that Base UI _is_ a standalone library, and it doesn't come packaged with _any_ default styles or themes.
86+
Rest assured that MUI Base _is_ a standalone library, and it doesn't come packaged with _any_ default styles or themes.
87+
88+
But to make it clear, and to reflect all the breaking changes coming in 2024, the new version of MUI Base will be called **Base UI**.
8789

8890
<img alt="Material UI vs. Base UI: independent but related products." src="/static/blog/base-ui-2024-plans/material-vs-base.png" width="2400" height="900" loading="lazy" />
8991

docs/src/components/productBaseUI/MuiBaseDeprecation.tsx

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@ import * as React from 'react';
22
import Box from '@mui/material/Box';
33
import { MarkdownElement } from '@mui/docs/MarkdownElement';
44

5-
export default function MuiBaseDeprecation(props: {
6-
newComponentName?: string;
7-
newComponentUrl?: string;
8-
}) {
9-
if (props.newComponentUrl && props.newComponentName) {
5+
export default function MuiBaseDeprecation(props: { newName?: string; newUrl?: string }) {
6+
if (props.newUrl && props.newName) {
107
return (
118
<MarkdownElement>
129
<Box component="aside" className="MuiCallout-root MuiCallout-error">
1310
<Icon />
1411
<Box className="MuiCallout-content">
15-
@mui/base has been deprecated and has been replaced by Base UI. We strongly recommend
16-
using the Base UI <a href={props.newComponentUrl}>{props.newComponentName} component</a>{' '}
12+
MUI Base (@mui/base) has been deprecated. Base UI is its successor. We strongly
13+
recommend using the new <a href={props.newUrl}>Base UI {props.newName} component</a>{' '}
1714
instead.
1815
</Box>
1916
</Box>
@@ -25,9 +22,8 @@ export default function MuiBaseDeprecation(props: {
2522
<Box component="aside" className="MuiCallout-root MuiCallout-error">
2623
<Icon />
2724
<Box className="MuiCallout-content">
28-
@mui/base has been deprecated and has been replaced by{' '}
29-
<a href="https://base-ui.com">Base UI</a>. We strongly recommend using the new package
30-
instead.
25+
MUI Base (@mui/base) has been deprecated. <a href="https://base-ui.com">Base UI</a> is its
26+
successor. We strongly recommend using the new package instead.
3127
</Box>
3228
</Box>
3329
</MarkdownElement>

docs/src/modules/components/MarkdownDocs.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ export default function MarkdownDocs(props) {
7878
{isJoy && <JoyModeObserver mode={theme.palette.mode} />}
7979
{isBase && (
8080
<MuiBaseDeprecation
81-
newComponentUrl={localizedDoc.headers.newUrl}
82-
newComponentName={localizedDoc.headers.newName}
81+
newUrl={localizedDoc.headers.newUrl}
82+
newName={localizedDoc.headers.newName}
8383
/>
8484
)}
8585
{localizedDoc.rendered.map((renderedMarkdownOrDemo, index) => (

docs/src/modules/components/MarkdownDocsV2.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,8 @@ export default function MarkdownDocsV2(props) {
276276
{isJoy && <JoyModeObserver mode={theme.palette.mode} />}
277277
{isBase && (
278278
<MuiBaseDeprecation
279-
newComponentUrl={localizedDoc.headers.newUrl}
280-
newComponentName={localizedDoc.headers.newName}
279+
newUrl={localizedDoc.headers.newUrl}
280+
newName={localizedDoc.headers.newName}
281281
/>
282282
)}
283283
{commonElements}

packages/mui-base/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<!-- markdownlint-disable-next-line -->
22
<p align="center">
3-
<a href="https://mui.com/base-ui/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="Base UI logo"></a>
3+
<a href="https://mui.com/base-ui/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="MUI Base logo"></a>
44
</p>
55

6-
<h1 align="center">Base UI</h1>
6+
<h1 align="center">MUI Base</h1>
77

8-
Base UI is a library of headless ("unstyled") React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
8+
MUI Base is a library of headless ("unstyled") React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.
99

1010
## Installation
1111

@@ -19,7 +19,7 @@ npm install @mui/base
1919

2020
<!-- #host-reference -->
2121

22-
Visit [https://v6.mui.com/base-ui/](https://v6.mui.com/base-ui/) to view the full documentation.
22+
Visit [https://v6.mui.com/base-ui/getting-started/](https://v6.mui.com/base-ui/getting-started/) to view the full documentation.
2323

2424
## Questions
2525

@@ -28,7 +28,7 @@ Use the "base-ui" tag on Stack Overflow to make it easier for the community to
2828

2929
## Examples
3030

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

3333
## Contributing
3434

packages/mui-base/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"bugs": {
2222
"url": "https://github.com/mui/material-ui/issues"
2323
},
24-
"homepage": "https://mui.com/base-ui/",
24+
"homepage": "https://v6.mui.com/base-ui/getting-started/",
2525
"funding": {
2626
"type": "opencollective",
2727
"url": "https://opencollective.com/mui-org"

0 commit comments

Comments
 (0)