Skip to content

Commit

Permalink
[docs] Fix brand name non-breaking space (mui#40701)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Jan 20, 2024
1 parent b6d93cf commit 8e48da3
Show file tree
Hide file tree
Showing 279 changed files with 1,781 additions and 1,775 deletions.
491 changes: 245 additions & 246 deletions CHANGELOG.md

Large diffs are not rendered by default.

122 changes: 61 additions & 61 deletions CHANGELOG.old.md

Large diffs are not rendered by default.

25 changes: 13 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to MUI
# Contributing to Material UI, Base UI, MUI System, Joy UI

If you're reading this, you're awesome!
Thank you for being a part of the MUI community and helping us make these projects great.
Thank you for being a part of the community and helping us make these projects great.
Here are a few guidelines that will help you along the way.

## Summary
Expand All @@ -25,12 +25,12 @@ Here are a few guidelines that will help you along the way.

## Code of conduct

MUI has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as our code of conduct, and we expect project participants to adhere to it.
We has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as our code of conduct, and we expect project participants to adhere to it.
Please read [the full text](https://github.com/mui/.github/blob/master/CODE_OF_CONDUCT.md) to understand what actions will and will not be tolerated.

## A large spectrum of contributions

There are [many ways](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) to contribute to MUI, and writing code is only one part of the story—[documentation improvements](#contributing-to-the-documentation) can be just as important as code changes.
There are [many ways](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) to contribute to the library, and writing code is only one part of the story—[documentation improvements](#contributing-to-the-documentation) can be just as important as code changes.
If you have an idea for an improvement to the code or the docs, we encourage you to open an issue as a first step, to discuss your proposed changes with the maintainers before proceeding.

## Your first pull request
Expand All @@ -54,7 +54,7 @@ If there has been no activity on the issue for 7 to 14 days, then it's safe to a

## Sending a pull request

MUI Core projects are community-driven, so pull requests are always welcome, but before working on a large change, it's best to open an issue first to discuss it with the maintainers.
MUI Core projects are community-driven, so pull requests are always welcome, but before working on a large change, it's best to open an issue first to discuss it with the maintainers.

When in doubt, keep your pull requests small.
For the best chances of being accepted, don't bundle more than one feature or bug fix per PR.
Expand Down Expand Up @@ -104,7 +104,7 @@ We will review your PR and either merge it, request changes to it, or close it w

### Trying changes on the documentation site

The documentation site is built with Material UI and contains examples of all of the components.
The documentation site is built with Material UI and contains examples of all of the components.
This is the best place to experiment with your changes—it's the local development environment used by the maintainers.

To get started, run:
Expand Down Expand Up @@ -180,9 +180,8 @@ The following sections give an overview of what each check is responsible for.

#### ci/codesandbox

This task creates multiple sandboxes on CodeSandbox.com that use the version of MUI that was built from this pull request.
It should not fail in isolation.
Use it to test more complex scenarios.
This task creates multiple sandboxes on CodeSandbox.com that use the version of npm packages that was built from this pull request.
It should not fail in isolation. Use it to test more complex scenarios.

#### ci/circleci: checkout

Expand Down Expand Up @@ -264,7 +263,7 @@ $ pnpm docs:api
### Coding style

Please follow the coding style of the project.
MUI Core projects use prettier and ESLint, so if possible, enable linting in your editor to get real-time feedback.
MUI Core projects use prettier and ESLint, so if possible, enable linting in your editor to get real-time feedback.

- `pnpm prettier` reformats the code.
- `pnpm eslint` runs the linting rules.
Expand Down Expand Up @@ -352,7 +351,7 @@ Alternatively, you can open the Netlify preview of the documentation, and open a
The documentation automatically configures the dependencies to use the preview packages.

You can also package and test your changes locally.
The following example shows how to package `@mui/material`, but you can package any MUI module with this process:
The following example shows how to package `@mui/material`, but you can package any npm package with this process:

```bash
$> cd packages/mui-material # or path to any other mui package
Expand All @@ -375,7 +374,9 @@ $test-project> npm i ./path-to-file/mui-material-x.x.x.tar.gz
## Roadmap

Learn more about the future of MUI and its products by visiting our [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
Learn more about the future by visiting our different projects' roadmaps:

- [Material UI roadmap](https://mui.com/material-ui/discover-more/roadmap/).

## License

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="MUI Core logo"></a>
<a href="https://mui.com/core/" rel="noopener" target="_blank"><img width="150" height="133" src="https://mui.com/static/logo.svg" alt="MUI Core logo"></a>
</p>

<h1 align="center">MUI Core</h1>
<h1 align="center">MUI Core</h1>

**MUI Core** contains foundational React UI component libraries for shipping new features faster:
**MUI Core** contains foundational React UI component libraries for shipping new features faster:

- [Material UI](https://mui.com/material-ui/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
- [Material UI](https://mui.com/material-ui/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.

- [Joy UI](https://mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy.

- [Base UI](https://mui.com/base-ui/) is a library of unstyled React UI components and hooks. With Base UI, you gain complete control over your app's CSS and accessibility features.
- [Base UI](https://mui.com/base-ui/) is a library of unstyled React UI components and hooks. With Base UI, you gain complete control over your app's CSS and accessibility features.

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

<div align="center">

Expand All @@ -33,7 +33,7 @@

## Documentation

### Material UI
### Material UI

Visit [https://mui.com/material-ui/](https://mui.com/material-ui/) to view the full documentation.

Expand All @@ -56,14 +56,14 @@ Visit [https://mui.com/joy-ui/getting-started/](https://mui.com/joy-ui/getting-s
**Note**: Joy UI is still in beta.
We are adding new components regularly and you're welcome to contribute!

### Base UI
### Base UI

Visit [https://mui.com/base-ui/](https://mui.com/base-ui/) to view the full documentation.

**Note**: Base UI is still in beta.
**Note**: Base UI is still in beta.
We are adding new components regularly and you're welcome to contribute!

### MUI System
### MUI System

Visit [https://mui.com/system/getting-started/](https://mui.com/system/getting-started/) to view the full documentation.

Expand Down Expand Up @@ -109,7 +109,7 @@ Our documentation features [a collection of example projects](https://github.com

## Premium templates

You can find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store).
You can find complete templates and themes in the [MUI Store](https://mui.com/store/?utm_source=docs&utm_medium=referral&utm_campaign=readme-store).

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion benchmark/browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Grid (html):
28.34 ±01.80ms
Grid System:
167 ±2%
Grid Material UI:
Grid Material UI:
179 ±1%
Table:
128 ±3%
Expand Down
2 changes: 1 addition & 1 deletion benchmark/browser/scripts/benchmark.js
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ async function run() {
name: 'Box Chakra-UI',
path: './box-chakra-ui/index.js',
},
// Test the system perf difference with alternatives
// Test MUI System perf difference with alternatives
{
name: 'styled-components Box + @mui/system',
path: './styled-components-box-material-ui-system/index.js',
Expand Down
2 changes: 1 addition & 1 deletion benchmark/server/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MUI benchmark
# Benchmark

## `@mui/material`

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MUI docs
# Docs

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

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

Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/all-components/all-components.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Base UI components
# Base UI components

<p class="description">Every Base UI component available so far, sorted alphabetically.</p>
<p class="description">Every Base UI component available so far, sorted alphabetically.</p>

{{"component": "modules/components/BaseUIComponents.js"}}
2 changes: 1 addition & 1 deletion docs/data/base/components/accordion/accordion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/accordion/
<p class="description">Accordions let users show and hide sections of related content on a page.</p>

:::warning
The Base UI Accordion component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38037) to see it arrive sooner.
The Base UI Accordion component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38037) to see it arrive sooner.
:::
12 changes: 6 additions & 6 deletions docs/data/base/components/autocomplete/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/

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.

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

{{"demo": "AutocompleteIntroduction", "defaultCodeOpen": false, "bg": "gradient"}}

:::warning
Material UI and Joy UI have Autocomplete components that are built using the `useAutocomplete` hook, and they include many features not yet described here.
Material UI and Joy UI have Autocomplete components that are built using the `useAutocomplete` hook, and they include many features not yet described here.

To learn more about implementing a custom Autocomplete, you can explore the [`useAutocomplete` API docs](/base-ui/react-autocomplete/hooks-api/#use-autocomplete), or reference the Material UI and Joy UI implementations:
To learn more about implementing a custom Autocomplete, you can explore the [`useAutocomplete` API docs](/base-ui/react-autocomplete/hooks-api/#use-autocomplete), or reference the Material UI and Joy UI implementations:

- [Material UI Autocomplete](/material-ui/react-autocomplete/)
- [Material UI Autocomplete](/material-ui/react-autocomplete/)
- [Joy UI Autocomplete](/joy-ui/react-autocomplete/)

:::
Expand Down Expand Up @@ -102,9 +102,9 @@ Learn more about controlled and uncontrolled components in the [React documentat

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-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.
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:
To render the listbox in Base UI's Popper, the `ref`s must be merged as follows:

```jsx
import { useAutocomplete } from '@mui/base/useAutocomplete';
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/button/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ You can even use SVGs, as shown in the demo below:

### Using with links

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):
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):

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

Expand All @@ -142,7 +142,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-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)).
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
2 changes: 1 addition & 1 deletion docs/data/base/components/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/checkbox/
<p class="description">Checkboxes give users binary choices when presented with multiple options in a series.</p>

:::warning
The Base UI Checkbox component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38036) to see it arrive sooner.
The Base UI Checkbox component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38036) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/drawer/drawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ githubLabel: 'component: drawer'
<p class="description">Navigation drawers (also known as sidebars) provide ergonomic access to different destinations without taking the user out of context.</p>

:::warning
The Base UI Drawer component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38181) to see it arrive sooner.
The Base UI Drawer component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38181) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/menu/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/

## Introduction

The Base UI Dropdown Menu is implemented using a collection of related components:
The Base UI Dropdown Menu is implemented using a collection of related components:

- Dropdown - The outermost container that houses all Menu components.
- Menu Button - The button that toggles the visibility of the Menu.
Expand Down
2 changes: 1 addition & 1 deletion docs/data/base/components/modal/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ As such, it should be used sparingly—only when the app _requires_ user input b
<!-- Uncomment the next line, once an unstyled dialog component is added in @mui/base -->
<!-- If you are creating a modal dialog, the [`Dialog`](/material-ui/dialog/) component is better suited for this specific use case. -->

Modal is a lower-level construct that is used in the following Material UI components:
Modal is a lower-level construct that is used in the following Material UI components:

- [Dialog](/material-ui/react-dialog/)
- [Drawer](/material-ui/react-drawer/)
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/number-input/number-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ githubLabel: 'component: number input'
## Introduction

A number input is a UI element that accepts numeric values from the user.
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:
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:

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

### Anatomy

The Base UI Number Input component consists of four slots:
The Base UI Number Input component consists of four slots:

- `root`: an outer `<div>` containing the other interior slots
- `input`: an `<input>` element
Expand Down
2 changes: 1 addition & 1 deletion docs/data/base/components/pagination/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ githubLabel: 'component: Pagination'
<p class="description">The Pagination component lets the user select a specific page from a range of pages.</p>

:::warning
The Base UI Pagination component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38042) to see it arrive sooner.
The Base UI Pagination component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38042) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/popper/popper.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ It relies on the third-party library ([Popper.js v2](https://popper.js.org/docs/
The Popper.js library is no longer maintained.
It has been replaced by a new library: [Floating UI](https://floating-ui.com/).

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

Once the [Popup](/base-ui/react-popup/) is stable, we will deprecate and, later, remove our Popper component.
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/components/popup/popup.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It relies on the third-party [Floating UI](https://floating-ui.com/) library for
{{"demo": "UnstyledPopupIntroduction", "defaultCodeOpen": false, "bg": "gradient"}}

:::info
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.
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.
:::

## Component
Expand Down Expand Up @@ -61,7 +61,7 @@ Try changing this value to `top` in the interactive demo below to see how it wor
### Transitions

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

### Disable portal

Expand Down
2 changes: 1 addition & 1 deletion docs/data/base/components/radio-button/radio-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/radio/
<p class="description">Radio buttons enable the user to select one option from a set.</p>

:::warning
The Base UI Radio Button component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38038) to see it arrive sooner.
The Base UI Radio Button component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38038) to see it arrive sooner.
:::
2 changes: 1 addition & 1 deletion docs/data/base/components/rating/rating.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ waiAria: https://www.w3.org/WAI/tutorials/forms/custom-controls/#a-star-rating
<p class="description">Rating components provide users with a simple action to give feedback as well as assess the opinions of others.</p>

:::warning
The Base UI Rating component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38043) to see it arrive sooner.
The Base UI Rating component isn't available yet, but you can upvote [this GitHub issue](https://github.com/mui/material-ui/issues/38043) to see it arrive sooner.
:::
Loading

0 comments on commit 8e48da3

Please sign in to comment.