Skip to content

Commit

Permalink
[docs] Update /base url references to /base-ui (mui#37412)
Browse files Browse the repository at this point in the history
Co-authored-by: Marija Najdova <mnajdova@gmail.com>
  • Loading branch information
2 people authored and pull[bot] committed Mar 1, 2024
1 parent 597fa55 commit 76abc93
Show file tree
Hide file tree
Showing 315 changed files with 791 additions and 757 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@ _Mar 14, 2023_

A big thanks to the 13 contributors who made this release possible. Here are some highlights ✨:

- @michaldudak added an option for [disabling the generation](https://mui.com/base/getting-started/customization/#disabling-default-css-classes) of the default classes in Base UI (#35963)
- @michaldudak added an option for [disabling the generation](https://mui.com/base-ui/getting-started/customization/#disabling-default-css-classes) of the default classes in Base UI (#35963)
- other 🐛 bug fixes and 📚 documentation improvements.

### `@mui/material@5.11.13`
Expand Down Expand Up @@ -950,7 +950,7 @@ _Feb 27, 2023_

A big thanks to the 15 contributors who made this release possible. Here are some highlights ✨:

- 📚 added API documentation for the slots in Base UI and Joy UI by @hbjORbj, for e.g. [SliderUnstyled API](https://mui.com/base/api/slider-unstyled/#slots)
- 📚 added API documentation for the slots in Base UI and Joy UI by @hbjORbj, for e.g. [SliderUnstyled API](https://mui.com/base-ui/api/slider-unstyled/#slots)
- other 🐛 bug fixes and 📚 documentation improvements.

### `@mui/material@5.11.11`
Expand Down Expand Up @@ -1319,7 +1319,7 @@ A big thanks to the 13 contributors who made this release possible. Here are som
+ <SliderUnstyled slots={{ valueLabel: SliderValueLabel }} />
```

The following demo shows how to show a value label when it is hovered over with the thumb: https://mui.com/base/react-slider/#value-label
The following demo shows how to show a value label when it is hovered over with the thumb: https://mui.com/base-ui/react-slider/#value-label

- The following classes are removed from `sliderUnstyledClasses` since they are not needed for the value label:

Expand Down Expand Up @@ -2312,7 +2312,7 @@ _Oct 3, 2022_

A big thanks to the 18 contributors who made this release possible. Here are some highlights ✨:

- 🚀 [SnackbarUnstyled](https://mui.com/base/react-snackbar/) component & headless hook are added to Base UI (#33227) @ZeeshanTamboli
- 🚀 [SnackbarUnstyled](https://mui.com/base-ui/react-snackbar/) component & headless hook are added to Base UI (#33227) @ZeeshanTamboli
- 📚 [CSS variables documentation](https://mui.com/material-ui/experimental-api/css-theme-variables/overview/) for Material UI has been added by @siriwatknp (#33958)
- And more 🐛 bug fixes and 📚 documentation improvements.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

- [_Joy UI_](https://mui.com/joy-ui/getting-started/overview/) is a beautifully designed library of React UI components.

- [_Base UI_](https://mui.com/base/getting-started/overview/) is our library of "unstyled" components and low-level hooks. With Base, you gain complete control over your app's CSS and accessibility features.
- [_Base UI_](https://mui.com/base-ui/getting-started/overview/) is our library of "unstyled" components and low-level hooks. With Base, you gain complete control over your app's CSS and accessibility features.

- [_MUI System_](https://mui.com/system/getting-started/overview/) is a collection of CSS utilities to help you rapidly lay out custom designs.

Expand Down Expand Up @@ -179,7 +179,7 @@ Our documentation features [a collection of example projects using Material UI](

- [Material UI](https://mui.com/material-ui/getting-started/overview/)
- [Joy UI](https://mui.com/joy-ui/getting-started/overview/)
- [Base UI](https://mui.com/base/getting-started/overview/)
- [Base UI](https://mui.com/base-ui/getting-started/overview/)
- [MUI System](https://mui.com/system/getting-started/overview/)

## Premium themes
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/autocomplete/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To learn more about implementing a custom Autocomplete, you can explore the [`us

## Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this hook as follows:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this hook as follows:

```jsx
import useAutocomplete from '@mui/base/useAutocomplete';
Expand Down Expand Up @@ -128,7 +128,7 @@ These two states are isolated, and should be controlled independently.

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.

Base UI provides a [`<Popper />`](/base/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.
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.

To render the listbox in Base UI's Popper, the `ref`s must be merged as follows:

Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/badge/badge-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The `BadgeUnstyled` component creates a badge that is applied to its child eleme

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import BadgeUnstyled from '@mui/base/BadgeUnstyled';
Expand Down Expand Up @@ -57,7 +57,7 @@ The `BadgeUnstyled` component is composed of a root `<span>` that houses the ele
### Slot props

:::info
The following props are available on all non-utility Base components. See [Usage](/base/getting-started/usage/) for full details.
The following props are available on all non-utility Base components. See [Usage](/base-ui/getting-started/usage/) for full details.
:::

Use the `component` prop to override the root slot with a custom element:
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/badge/badge-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The `BadgeUnstyled` component creates a badge that is applied to its child eleme

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import BadgeUnstyled from '@mui/base/BadgeUnstyled';
Expand Down Expand Up @@ -57,7 +57,7 @@ The `BadgeUnstyled` component is composed of a root `<span>` that houses the ele
### Slot props

:::info
The following props are available on all non-utility Base components. See [Usage](/base/getting-started/usage/) for full details.
The following props are available on all non-utility Base components. See [Usage](/base-ui/getting-started/usage/) for full details.
:::

Use the `component` prop to override the root slot with a custom element:
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/badge/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The Badge component creates a badge that is applied to its child element.

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import Badge from '@mui/base/Badge';
Expand Down Expand Up @@ -69,7 +69,7 @@ Use the `slots` prop to override the root or any other interior slot:

:::info
The `slots` prop is available on all non-utility Base components.
See [Overriding component structure](/base/guides/overriding-component-structure/) for full details.
See [Overriding component structure](/base-ui/guides/overriding-component-structure/) for full details.
:::

Use the `slotProps` prop to pass custom props to internal slots.
Expand Down
6 changes: 3 additions & 3 deletions docs/data/base/components/button/button-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import ButtonUnstyled from '@mui/base/ButtonUnstyled';
Expand Down Expand Up @@ -51,7 +51,7 @@ The `ButtonUnstyled` component is composed of a root `<button>` slot with no int
### Slot props

:::info
The following props are available on all non-utility Base components. See [Usage](/base/getting-started/usage/) for full details.
The following props are available on all non-utility Base components. See [Usage](/base-ui/getting-started/usage/) for full details.
:::

Use the `component` prop to override the root slot with a custom element:
Expand Down Expand Up @@ -133,7 +133,7 @@ The `focusableWhenDisabled` prop lets you change this behavior. When this prop i

This should be used whenever the disabled button needs to be read by screen readers.

Base UI uses this prop internally in [menu items](/base/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/#x6-7-focusability-of-disabled-controls)).
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/#x6-7-focusability-of-disabled-controls)).

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:

Expand Down
6 changes: 3 additions & 3 deletions docs/data/base/components/button/button-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/button/

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import ButtonUnstyled from '@mui/base/ButtonUnstyled';
Expand Down Expand Up @@ -51,7 +51,7 @@ The `ButtonUnstyled` component is composed of a root `<button>` slot with no int
### Slot props

:::info
The following props are available on all non-utility Base components. See [Usage](/base/getting-started/usage/) for full details.
The following props are available on all non-utility Base components. See [Usage](/base-ui/getting-started/usage/) for full details.
:::

Use the `component` prop to override the root slot with a custom element:
Expand Down Expand Up @@ -133,7 +133,7 @@ The `focusableWhenDisabled` prop lets you change this behavior. When this prop i

This should be used whenever the disabled button needs to be read by screen readers.

Base UI uses this prop internally in [menu items](/base/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/#x6-7-focusability-of-disabled-controls)).
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/#x6-7-focusability-of-disabled-controls)).

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:

Expand Down
6 changes: 3 additions & 3 deletions docs/data/base/components/button/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The Button component replaces the native HTML `<button>` element, and offers exp

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import Button from '@mui/base/Button';
Expand Down Expand Up @@ -64,7 +64,7 @@ Use the `slots.root` prop to override the root slot with a custom element:

:::info
The `slots` prop is available on all non-utility Base components.
See [Overriding component structure](/base/guides/overriding-component-structure/) for full details.
See [Overriding component structure](/base-ui/guides/overriding-component-structure/) for full details.
:::

If you provide a non-interactive element such as a `<span>`, the Button component will automatically add the necessary accessibility attributes.
Expand Down Expand Up @@ -146,7 +146,7 @@ Instead, `aria-disabled` is used, which makes the button focusable.

This should be used whenever the disabled button needs to be read by screen readers.

Base UI uses this prop internally in [menu items](/base/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/#x6-7-focusability-of-disabled-controls)).
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/#x6-7-focusability-of-disabled-controls)).

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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ githubLabel: 'component: ClickAwayListener'

`ClickAwayListener` is a utility component that listens for click events outside of its child. (Note that it only accepts _one_ child element.)

This is useful for components like [`PopperUnstyled`](/base/react-popper/) which should close when the user clicks anywhere else in the document.
This is useful for components like [`PopperUnstyled`](/base-ui/react-popper/) which should close when the user clicks anywhere else in the document.

`ClickAwayListener` also supports the [`Portal` component](/base/react-portal/).
`ClickAwayListener` also supports the [`Portal` component](/base-ui/react-portal/).

{{"component": "modules/components/ComponentLinkHeader.js", "design": false}}

## Component

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import ClickAwayListener from '@mui/base/ClickAwayListener';
Expand All @@ -45,7 +45,7 @@ The following demo shows how to hide a menu dropdown when users click anywhere e

### Usage with Portal

The following demo uses the [`Portal` component](/base/react-portal/) to render the dropdown into a new subtree outside of the current DOM hierarchy:
The following demo uses the [`Portal` component](/base-ui/react-portal/) to render the dropdown into a new subtree outside of the current DOM hierarchy:

{{"demo": "PortalClickAway.js"}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ githubLabel: 'component: ClickAwayListener'

`ClickAwayListener` is a utility component that listens for click events outside of its child. (Note that it only accepts _one_ child element.)

This is useful for components like [`PopperUnstyled`](/base/react-popper/) which should close when the user clicks anywhere else in the document.
This is useful for components like [`PopperUnstyled`](/base-ui/react-popper/) which should close when the user clicks anywhere else in the document.

`ClickAwayListener` also supports the [`Portal` component](/base/react-portal/).
`ClickAwayListener` also supports the [`Portal` component](/base-ui/react-portal/).

{{"component": "modules/components/ComponentLinkHeader.js", "design": false}}

## Component

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import ClickAwayListener from '@mui/base/ClickAwayListener';
Expand All @@ -45,7 +45,7 @@ The following demo shows how to hide a menu dropdown when users click anywhere e

### Usage with Portal

The following demo uses the [`Portal` component](/base/react-portal/) to render the dropdown into a new subtree outside of the current DOM hierarchy:
The following demo uses the [`Portal` component](/base-ui/react-portal/) to render the dropdown into a new subtree outside of the current DOM hierarchy:

{{"demo": "PortalClickAway.js"}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ githubLabel: 'component: ClickAwayListener'
Click-Away Listener is a utility component that listens for click events outside of its child.
(Note that it only accepts _one_ child element.)

This is useful for components like the [Popper](/base/react-popper/) which should close when the user clicks anywhere else in the document.
This is useful for components like the [Popper](/base-ui/react-popper/) which should close when the user clicks anywhere else in the document.

Click-Away Listener also supports the [Portal](/base/react-portal/) component.
Click-Away Listener also supports the [Portal](/base-ui/react-portal/) component.

## Component

### Usage

After [installation](/base/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:
After [installation](/base-ui/getting-started/quickstart/#installation), you can start building with this component using the following basic elements:

```jsx
import ClickAwayListener from '@mui/base/ClickAwayListener';
Expand All @@ -48,7 +48,7 @@ The following demo shows how to hide a menu dropdown when users click anywhere e

### Usage with Portal

The following demo uses the [Portal](/base/react-portal/) component to render the dropdown into a new subtree outside of the current DOM hierarchy:
The following demo uses the [Portal](/base-ui/react-portal/) component to render the dropdown into a new subtree outside of the current DOM hierarchy:

{{"demo": "PortalClickAway.js"}}

Expand Down
Loading

0 comments on commit 76abc93

Please sign in to comment.