Skip to content

Commit ca6afdb

Browse files
mj12albertmnajdova
andauthored
[docs] Rename "Base UI" to "MUI Base" in all text (#45060)
Co-authored-by: mnajdova <[email protected]>
1 parent 33ce030 commit ca6afdb

File tree

78 files changed

+256
-253
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+256
-253
lines changed

.eslintrc.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,7 @@ module.exports = /** @type {Config} */ ({
343343
patterns: NO_RESTRICTED_IMPORTS_PATTERNS_DEEPLY_NESTED,
344344
},
345345
],
346+
'no-irregular-whitespace': ['error', { skipJSXText: true, skipStrings: true }],
346347
},
347348
},
348349
{
@@ -519,6 +520,7 @@ module.exports = /** @type {Config} */ ({
519520
'import/no-default-export': 'error',
520521
'import/prefer-default-export': 'off',
521522
'react-compiler/react-compiler': 'off',
523+
'no-irregular-whitespace': ['error', { skipComments: true }],
522524
},
523525
},
524526
{
@@ -544,6 +546,7 @@ module.exports = /** @type {Config} */ ({
544546
// Reset the default until https://github.com/jsx-eslint/eslint-plugin-react/issues/3672 is fixed.
545547
'react/jsx-no-target-blank': ['error', { allowReferrer: false }],
546548
'react/prop-types': 'off',
549+
'no-irregular-whitespace': ['error', { skipJSXText: true, skipStrings: true }],
547550
},
548551
},
549552
{

CHANGELOG.old.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3151,7 +3151,7 @@ A big thanks to the 12 contributors who made this release possible. Here are som
31513151
- [docs][base] Remove usage of `component` prop in docs (#37462) @sai6855
31523152
- [docs] Fix docs redirections @oliviertassinari
31533153
- [docs] Fix Fluent -> Fluent UI @oliviertassinari
3154-
- [docs] Fix MUI Base -> Base UI @oliviertassinari
3154+
- [docs] Fix MUI Base -> Base UI @oliviertassinari
31553155
- [docs] Add base-vite-tailwind example repo (#36994) @mj12albert
31563156
- [docs] Fix search bar layout shift (#37460) @oliviertassinari
31573157
- [docs] Tweak Material UI's "Showcase" page design (#37259) @danilo-leal
@@ -3366,7 +3366,7 @@ A big thanks to the 18 contributors who made this release possible. Here are som
33663366

33673367
### Core
33683368

3369-
- [blog] Fix images using "MUI Base" instead of "Base UI" (#37044) @danilo-leal
3369+
- [blog] Fix images using "MUI Base" instead of "Base UI" (#37044) @danilo-leal
33703370
- [core] Add VS Code extensions recommendations (#37166) @michaldudak
33713371
- [test] `e2e-website` related minor fixes (#37204) @ZeeshanTamboli
33723372

@@ -3671,7 +3671,7 @@ A big thanks to the 9 contributors who made this release possible. Here are some
36713671
### Core
36723672

36733673
- [core] Increase margin to scroll @oliviertassinari
3674-
- [core] Replace MUI Base with Base UI (#36716) @mnajdova
3674+
- [core] Replace MUI Base with Base UI (#36716) @mnajdova
36753675

36763676
All contributors of this release in alphabetical order: @alirezahekmati, @danilo-leal, @hbjORbj, @Lioness100, @mnajdova, @oliviertassinari, @sai6855, @siriwatknp, @ZeeshanTamboli
36773677

@@ -3711,7 +3711,7 @@ A big thanks to the 17 contributors who made this release possible. Here are som
37113711
- [docs][base] Move styles to the bottom of demos code for `Menu` (#36582) @gitstart
37123712
- [docs][base] Move styles code to bottom in the `Button` demos (#36590) @sai6855
37133713
- [docs][base] Show components & hooks API on the components page (#35938) @mnajdova
3714-
- [docs] Describe slotProps in MUI Base customization doc (#36206) @michaldudak
3714+
- [docs] Describe slotProps in MUI Base customization doc (#36206) @michaldudak
37153715
- [docs] Fix double API page redirection (#36743) @oliviertassinari
37163716
- [docs] Remove hash property and leverage pathname (#36764) @siriwatknp
37173717
- [docs] Introduce markdown permalink to source (#36729) @oliviertassinari

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Docs
22

3-
This is the website of the company (MUI), the documentation of Material UI, Base UI, MUI System, and Joy UI.
3+
This is the website of the company (MUI), the documentation of Material UI, MUI Base, MUI System, and Joy UI.
44

55
To start the docs site in development mode, from the project root, run:
66

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Base UI components
1+
# MUI Base components
22

3-
<p class="description">Every Base UI component available so far, sorted alphabetically.</p>
3+
<p class="description">Every MUI Base component available so far, sorted alphabetically.</p>
44

55
{{"component": "modules/components/BaseUIComponents.js"}}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/
1818

1919
An autocomplete component is an enhanced text input that shows a list of suggested options as users type and lets them select an option from the list.
2020

21-
Base UI provides the `useAutocomplete` hook for building a custom Autocomplete.
21+
MUI Base provides the `useAutocomplete` hook for building a custom Autocomplete.
2222
It implements the WAI-ARIA Combobox pattern and is typically used to assist users in completing form inputs or search queries faster.
2323

2424
{{"demo": "AutocompleteIntroduction", "defaultCodeOpen": false, "bg": "gradient"}}
@@ -102,9 +102,9 @@ Learn more about controlled and uncontrolled components in the [React documentat
102102

103103
React Portals can be used to render the listbox outside of the DOM hierarchy, making it easier to allow it to "float" above adjacent elements.
104104

105-
Base UI provides a [Popper](/base-ui/react-popper/) component built around React's `createPortal()` for exactly this purpose, and additionally helps you manage keyboard focus as it moves in and out of the portal.
105+
MUI Base provides a [Popper](/base-ui/react-popper/) component built around React's `createPortal()` for exactly this purpose, and additionally helps you manage keyboard focus as it moves in and out of the portal.
106106

107-
To render the listbox in Base UI's Popper, the `ref`s must be merged as follows:
107+
To render the listbox in MUI Base's Popper, the `ref`s must be merged as follows:
108108

109109
```jsx
110110
import { useAutocomplete } from '@mui/base/useAutocomplete';

docs/data/base/components/button/button.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ You can even use SVGs, as shown in the demo below:
127127

128128
### Using with links
129129

130-
The following demo illustrates how to use the Button as a link, whether using the Base UI Button itself for the `href`, or with the [Next.js Link component](https://nextjs.org/docs/pages/api-reference/components/link):
130+
The following demo illustrates how to use the Button as a link, whether using the MUI Base Button itself for the `href`, or with the [Next.js Link component](https://nextjs.org/docs/pages/api-reference/components/link):
131131

132132
{{"demo": "UnstyledLinkButton.js", "defaultCodeOpen": true}}
133133

@@ -142,7 +142,7 @@ Instead, `aria-disabled` is used, which makes the Button focusable.
142142

143143
This should be used whenever the disabled Button needs to be read by screen readers.
144144

145-
Base UI uses this prop internally in [menu items](/base-ui/react-menu/), making it possible to use the keyboard to navigate to disabled items (in compliance with [ARIA guidelines](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols)).
145+
MUI Base uses this prop internally in [menu items](/base-ui/react-menu/), making it possible to use the keyboard to navigate to disabled items (in compliance with [ARIA guidelines](https://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#focusabilityofdisabledcontrols)).
146146

147147
The following demo shows how the `focusableWhenDisabled` prop works—use the <kbd class="key">Tab</kbd> key to navigate within this document to see that only the second Button accepts the focus:
148148

docs/data/base/components/drawer/drawer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ githubLabel: 'component: drawer'
99
<p class="description">Navigation drawers (also known as sidebars) provide ergonomic access to different destinations without taking the user out of context.</p>
1010

1111
:::error
12-
@mui/base has been deprecated and replaced by Base UI. Please follow [this GitHub issue](https://github.com/mui/base-ui/issues/38) to track the development of the Drawer component.
12+
@mui/base has been deprecated and replaced by MUI Base. Please follow [this GitHub issue](https://github.com/mui/base-ui/issues/38) to track the development of the Drawer component.
1313
:::

docs/data/base/components/menu/menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ newName: Menu
1919

2020
## Introduction
2121

22-
The Base UI Dropdown Menu is implemented using a collection of related components:
22+
The MUI Base Dropdown Menu is implemented using a collection of related components:
2323

2424
- Dropdown - The outermost container that houses all Menu components.
2525
- Menu Button - The button that toggles the visibility of the Menu.

docs/data/base/components/number-input/number-input.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ newName: Number Field
1919
## Introduction
2020

2121
A number input is a UI element that accepts numeric values from the user.
22-
Base UI's Number Input component is a customizable replacement for the native HTML `<input type="number">` that solves common usability issues of its native counterpart, such as:
22+
MUI Base's Number Input component is a customizable replacement for the native HTML `<input type="number">` that solves common usability issues of its native counterpart, such as:
2323

2424
- Inconsistencies across browsers in the appearance and behavior of the stepper buttons
2525
- Allowing certain non-numeric characters ('e', '+', '-', '.') and silently discarding others
@@ -43,7 +43,7 @@ The following demo shows how to create a Number Input component, apply some styl
4343

4444
### Anatomy
4545

46-
The Base UI Number Input component consists of four slots:
46+
The MUI Base Number Input component consists of four slots:
4747

4848
- `root`: an outer `<div>` containing the other interior slots
4949
- `input`: an `<input>` element

docs/data/base/components/pagination/pagination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ githubLabel: 'component: Pagination'
99
<p class="description">The Pagination component lets the user select a specific page from a range of pages.</p>
1010

1111
:::error
12-
@mui/base has been deprecated and replaced by Base UI. Please follow [this GitHub issue](https://github.com/mui/base-ui/issues/29) to track the development of the Pagination component.
12+
@mui/base has been deprecated and replaced by MUI Base. Please follow [this GitHub issue](https://github.com/mui/base-ui/issues/29) to track the development of the Pagination component.
1313
:::

docs/data/base/components/popper/popper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ It relies on the third-party library ([Popper.js v2](https://popper.js.org/docs/
2525
The Popper.js library is no longer maintained.
2626
It has been replaced by a new library: [Floating UI](https://floating-ui.com/).
2727

28-
Base UI offers the [Popup](/base-ui/react-popup/) component based on this new library.
28+
MUI Base offers the [Popup](/base-ui/react-popup/) component based on this new library.
2929
It has features and an API similar to the Popper component, but is still in development and its API may change.
3030

3131
Once the [Popup](/base-ui/react-popup/) is stable, we will deprecate and, later, remove our Popper component.

docs/data/base/components/popup/popup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ It relies on the third-party [Floating UI](https://floating-ui.com/) library for
2424
{{"demo": "UnstyledPopupIntroduction", "defaultCodeOpen": false, "bg": "gradient"}}
2525

2626
:::info
27-
The Popup component, once stable, is intended to replace the [Popper](/base-ui/react-popper/) component, which will be phased out in a future release of Base UI.
27+
The Popup component, once stable, is intended to replace the [Popper](/base-ui/react-popper/) component, which will be phased out in a future release of MUI Base.
2828
:::
2929

3030
## Component
@@ -63,7 +63,7 @@ Try changing this value to `top` in the interactive demo below to see how it wor
6363
### Transitions
6464

6565
You can animate the opening and closing of the Popup using CSS transitions, CSS animations, or third-party animation libraries.
66-
It supports the API described on the [Base UI Transitions](/base-ui/react-transitions/) page.
66+
It supports the API described on the [MUI Base Transitions](/base-ui/react-transitions/) page.
6767

6868
### Disable portal
6969

docs/data/base/components/rating/rating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/tutorials/forms/custom-controls/#a-star-rating
1010
<p class="description">Rating components provide users with a simple action to give feedback as well as assess the opinions of others.</p>
1111

1212
:::error
13-
@mui/base has been deprecated and replaced by Base UI. Please follow [this GitHub issue](https://github.com/mui/base-ui/issues/30) to track the development of the Rating component.
13+
@mui/base has been deprecated and replaced by MUI Base. Please follow [this GitHub issue](https://github.com/mui/base-ui/issues/30) to track the development of the Rating component.
1414
:::

docs/data/base/components/select/select.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ newName: Select
2121

2222
A select is a UI element that gives users a list of options to choose from.
2323

24-
Base UI's Select component replaces the native HTML `<select>` tag.
24+
MUI Base's Select component replaces the native HTML `<select>` tag.
2525
It also includes the Option component for creating the options in the list, and Option Group for grouping those options.
2626

2727
{{"demo": "UnstyledSelectIntroduction", "defaultCodeOpen": false, "bg": "gradient"}}
@@ -95,9 +95,9 @@ The uncontrolled component accepts the `defaultValue` that can be used to set th
9595
To deselect all values, pass `null` to the respective prop.
9696

9797
:::warning
98-
This pattern is where Base UI's Select differs from the equivalent [Material UI component](/material-ui/react-select/).
98+
This pattern is where MUI Base's Select differs from the equivalent [Material UI component](/material-ui/react-select/).
9999
The Material UI Select takes an empty string to deselect all values.
100-
In Base UI, you must use `null` to achieve this.
100+
In MUI Base, you must use `null` to achieve this.
101101
:::
102102

103103
### Object values

docs/data/base/components/transitions/transitions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ hooks: useTransitionTrigger, useTransitionStateManager
1313

1414
## Introduction
1515

16-
Base UI offers higher-level components and low-level hooks that can be used to add animations to components as they enter and exit the screen.
16+
MUI Base offers higher-level components and low-level hooks that can be used to add animations to components as they enter and exit the screen.
1717

1818
:::info
1919
The [Popup](/base-ui/react-popup/) is currently the only component that supports this API; [Select](/base-ui/react-select/) and [Menu](/base-ui/react-menu/) support will be added next.
2020
:::
2121

2222
## Components
2323

24-
Base UI offers two components to cover the majority of use cases using [CSS transitions](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions/Using_CSS_transitions) and [animations](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_animations/Using_CSS_animations).
24+
MUI Base offers two components to cover the majority of use cases using [CSS transitions](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_transitions/Using_CSS_transitions) and [animations](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_animations/Using_CSS_animations).
2525

2626
### CSS Transition
2727

@@ -74,6 +74,6 @@ You can use any of the [transitions from Material UI](/material-ui/transitions/
7474

7575
### React Spring
7676

77-
React Spring, another popular animation library, also can be used with the Base UI transitions API.
77+
React Spring, another popular animation library, also can be used with the MUI Base transitions API.
7878

7979
{{"demo": "ReactSpring.js"}}

docs/data/base/getting-started/accessibility/accessibility.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Accessibility
22

3-
<p class="description">Learn how to make the most of Base UI's accessibility features and guidelines.</p>
3+
<p class="description">Learn how to make the most of MUI Base's accessibility features and guidelines.</p>
44

5-
Accessibility is our top priority for Base UI components.
5+
Accessibility is our top priority for MUI Base components.
66
However, the library cannot make your application fully accessible on its own.
77
This page highlights the most common actions that you as a developer must take to ensure that your app is accessible to users who require assistive technologies.
88

99
## Keyboard navigation
1010

11-
Base UI components follow the [WAI-ARIA 1.2 standard](https://www.w3.org/TR/wai-aria-1.2/), so they are accessible with a keyboard out of the box.
11+
MUI Base components follow the [WAI-ARIA 1.2 standard](https://www.w3.org/TR/wai-aria-1.2/), so they are accessible with a keyboard out of the box.
1212
This is important for users who have trouble using a pointing device, but also comes in handy for users who find navigating with a keyboard faster, and who expect web components to behave the same way as native operating system controls.
1313

1414
Specifically, interactive components can be focused using the <kbd class="key">Tab</kbd> key.
@@ -19,15 +19,15 @@ The Select and Menu also let users navigate to options that begin with a provide
1919

2020
## Focus ring
2121

22-
While Base UI components handle keyboard navigation, it's the developer's responsibility to indicate when a component is focused and can receive keyboard input.
22+
While MUI Base components handle keyboard navigation, it's the developer's responsibility to indicate when a component is focused and can receive keyboard input.
2323
This is usually done by styling the [`:focus`](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus) or [`:focus-visible`](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible) pseudoclasses.
2424
Read the [WCAG guidelines on focus appearance](https://www.w3.org/WAI/WCAG22/Understanding/focus-appearance) to learn more about requirements for focus indicators.
2525

2626
{{"demo": "FocusRing.js", "defaultCodeOpen": false}}
2727

2828
## Color contrast
2929

30-
Since Base UI components are unstyled, it's up to you to implement the appropriate amount of color contrast between text and background.
30+
Since MUI Base components are unstyled, it's up to you to implement the appropriate amount of color contrast between text and background.
3131
You can use [C. Liam Brown's Color Contrast Tool](https://cliambrown.com/contrast/) to measure contrast between colors in your design and ensure that they meet the minimum requirements
3232
(note that this tool uses the [APCA algorithm](https://ruitina.com/apca-accessible-colour-contrast/), which is slated to become the new standard in WCAG 3).
3333

docs/data/base/getting-started/customization/customization.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Customizing Base UI components
1+
# Customizing MUI Base components
22

3-
<p class="description">There are several ways to customize Base UI components, from applying custom CSS rules to building fully custom components using hooks.</p>
3+
<p class="description">There are several ways to customize MUI Base components, from applying custom CSS rules to building fully custom components using hooks.</p>
44

5-
With Base UI, you have the freedom to decide how much you want to customize a component's structure and style.
5+
With MUI Base, you have the freedom to decide how much you want to customize a component's structure and style.
66

77
## Styling the components
88

99
This section reviews several methods of customization that are available: applying custom CSS rules, overriding default subcomponent slots, customizing the slot props, and using hooks to build fully custom components.
1010

1111
### Which option to choose?
1212

13-
The multitude of options can be overwhelming, especially if you're new to Base UI.
13+
The multitude of options can be overwhelming, especially if you're new to MUI Base.
1414
How to decide which one to use, then?
1515

1616
The first decision to make is whether to use unstyled components or hooks.
1717
Hooks are better suited for making component libraries that can be further customized.
18-
For example, our own Joy UI is implemented using hooks from Base UI.
18+
For example, our own Joy UI is implemented using hooks from MUI Base.
1919
Hooks also serve as the basis for several Material UI components, and future versions of the library will use them even more extensively.
2020

2121
If you don't need to make your component library customizable (for instance, by exposing `slotProps`), then the unstyled components may be a better option thanks to their simplicity.
@@ -83,7 +83,7 @@ export default function Switch(props) {
8383
}
8484
```
8585

86-
See our [Working with Tailwind CSS guide](/base-ui/guides/working-with-tailwind-css/) for more information about integrating Base UI and Tailwind CSS.
86+
See our [Working with Tailwind CSS guide](/base-ui/guides/working-with-tailwind-css/) for more information about integrating MUI Base and Tailwind CSS.
8787

8888
#### Styled components
8989

0 commit comments

Comments
 (0)