Skip to content

Commit

Permalink
[docs] Standardize the usage of callouts in the MUI Core docs (#35361)
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelsycamore committed Dec 7, 2022
1 parent f646bcc commit 845ac04
Show file tree
Hide file tree
Showing 79 changed files with 163 additions and 190 deletions.
2 changes: 1 addition & 1 deletion docs/data/base/components/portal/portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The following demo shows how a `<span>` nested within a Portal can be appended t

### Server-side

:::warning
:::error
React doesn't support the [`createPortal()` API](https://reactjs.org/docs/portals.html) on the server.
See [this GitHub issue](https://github.com/facebook/react/issues/13097) for details.
:::
Expand Down
4 changes: 2 additions & 2 deletions docs/data/base/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ MUI Base includes prebuilt components with production-ready functionality, along

With MUI Base, you can rapidly build on top of our foundational components using any styling solution you choose—no need to override any default style engine or theme.

:::info
**Note:** as of today, MUI Base is in alpha.
:::warning
MUI Base is currently in alpha.

We're adding new components and features regularly, and you're welcome to contribute!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Here's what it will look like in the end:
{{"demo": "PlayerFinal.js", "hideToolbar": true, "bg": true}}

:::info
💡 All credits go to the Tailwind Labs team for designing this component, found on the [Tailwind CSS website](https://tailwindcss.com/).
All credits go to the Tailwind Labs team for designing this component, found on the [Tailwind CSS website](https://tailwindcss.com/).
:::

## Setting up the project
Expand Down
6 changes: 3 additions & 3 deletions docs/data/joy/components/alert/alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/alert/

The Alert component can be used to provide important and potentially time-sensitive information in a way that does not interfere with the user's tasks. (Source: [ARIA APG](https://www.w3.org/WAI/ARIA/apg/patterns/alert/).)

:::warning
:::info
Alerts should not be confused with alert _dialogs_ ([ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/alertdialog/)), which _are_ intended to interrupt the user to obtain a response.
Use the Joy UI [Modal](https://mui.com/joy-ui/react-modal/) if you need the behavior of a dialog.
:::
Expand All @@ -40,7 +40,7 @@ The Alert component supports Joy UI's four [global variants](/joy-ui/main-featur

{{"demo": "AlertVariants.js"}}

:::success
:::info
To learn how to add your own variants, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
Note that you lose the global variants when you add custom variants.
:::
Expand All @@ -51,7 +51,7 @@ The Alert component comes in three sizes: `sm`, `md` (default), and `lg`:

{{"demo": "AlertSizes.js"}}

:::success
:::info
To learn how to add custom sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/data/joy/components/aspect-ratio/aspect-ratio.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The Aspect Ratio component supports Joy UI's four [global variants](/joy-ui/main

{{"demo": "VariantsRatio.js"}}

:::success
:::info
To learn how to add your own variants, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
Note that you lose the global variants when you add custom variants.
:::
Expand Down Expand Up @@ -105,7 +105,7 @@ function App() {

### Mobile carousel

:::info
:::warning
In designs like this, make sure to assign a `minWidth` value to prevent the Aspect Ratio component from shrinking.
:::

Expand Down
8 changes: 4 additions & 4 deletions docs/data/joy/components/autocomplete/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The autocomplete component supports the four global variants: `outlined` (defaul

{{"demo": "InputAppearance.js"}}

:::success
:::info
To learn how to add more variants to the component, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
:::

Expand All @@ -98,7 +98,7 @@ The component has two states that can be controlled:
2. the "input value" state with the `inputValue`/`onInputChange` props combination. This state represents the value displayed in the textbox.

:::warning
⚠️ These two states are isolated, they should be controlled independently.
These two states are isolated, and should be controlled independently.
:::

{{"demo": "ControllableStates.js"}}
Expand Down Expand Up @@ -130,7 +130,7 @@ Use `freeSolo` to create a **search input** with suggestions experience, e.g. Go
{{"demo": "FreeSolo.js"}}

:::warning
⚠️ Be careful when using the free solo mode with non-string options, as it may cause type mismatch.
Be careful when using the free solo mode with non-string options, as it may cause type mismatch.

The value created by typing into the textbox is always a string, regardless of the type of the options.
:::
Expand Down Expand Up @@ -186,7 +186,7 @@ The autocomplete component comes with three sizes out of the box: `sm`, `md` (th

{{"demo": "Sizes.js"}}

:::success
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
6 changes: 3 additions & 3 deletions docs/data/joy/components/avatar/avatar.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The Avatar component supports Joy UI's four [global variants](/joy-ui/main-featu

{{"demo": "AvatarVariants.js"}}

:::success
:::info
To learn how to add your own variants, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
Note that you lose the global variants when you add custom variants.
:::
Expand All @@ -70,7 +70,7 @@ The Avatar component comes in three sizes: `sm`, `md` (default), and `lg`:

{{"demo": "AvatarSizes.js"}}

:::success
:::info
To learn how to add custom sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down Expand Up @@ -114,7 +114,7 @@ You can reverse the overlapping order by reversing the order of the Avatars and

To render the Avatar Group vertically, add the CSS `writing-mode: vertical-rl` property and rotate the interior element (if one is present) by -90 degrees.

:::info
:::success
This approach is preferable because it preserves the overlapping offset between Avatars; the alternative—`flexDirection: column`—does not.
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/data/joy/components/badge/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The Badge component supports Joy UI's four [global variants](/joy-ui/main-featur

{{"demo": "BadgeVariants.js"}}

:::success
:::info
To learn how to add your own variants, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
Note that you lose the global variants when you add custom variants.
:::
Expand All @@ -71,7 +71,7 @@ The Badge component comes in three sizes: `sm`, `md` (default), and `lg`:

{{"demo": "BadgeSizes.js"}}

:::success
:::info
To learn how to add custom sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/breadcrumbs/breadcrumbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Breadcrumbs component comes in three sizes: `sm`, `md` (default), and `lg`:

{{"demo": "BreadcrumbsSizes.js"}}

:::success
:::info
To learn how to add custom sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
8 changes: 4 additions & 4 deletions docs/data/joy/components/button/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Which variant you should choose depends on the relative importance of the button

{{"demo": "ButtonVariants.js"}}

:::success
:::info
To learn how to add more variants to the component, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
:::

Expand All @@ -54,7 +54,7 @@ The button components comes with three sizes out of the box: `sm`, `md` (the def

{{"demo": "ButtonSizes.js"}}

:::success
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down Expand Up @@ -99,8 +99,8 @@ import IconButton from '@mui/joy/IconButton';

{{"demo": "IconButtons.js"}}

:::info
**♿️ Accessibility tip**: Make sure to provide a meaningful [`aria-label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) to the icon button.
:::warning
Make sure to provide a meaningful [`aria-label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) to the icon button.
It helps screen readers to properly identify the component.

```js
Expand Down
12 changes: 6 additions & 6 deletions docs/data/joy/components/card/card.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ It uses [`object-fit: cover`](https://developer.mozilla.org/en-US/docs/Web/CSS/o

To create a gradient overlay, frequently seen when a colorful image is used as background, insert an additional `CardCover` component.

:::info
💡 **Tip:** Make sure to darken the gradient overlay up to have enough contrast between the background image and the text content.
:::warning
Make sure to darken the gradient overlay up to have enough contrast between the background image and the text content.
:::

{{"demo": "GradientCover.js" }}
Expand All @@ -87,8 +87,8 @@ The `CardOverflow` will adapt based on its position.
By default, whenever you have additional action elements such as links and buttons, they stay on top of the whole interactive area.
In some cases, you might have to manually control each element's `z-index`.

:::info
💡 **Tip**: use CSS's pseudo-class [`:focus-within`](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-within) to style the card when any of its children is focused.
:::success
Use the CSS pseudo-class [`:focus-within`](https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-within) to style the card when any of its children are focused.
:::

{{"demo": "MultipleInteractionCard.js" }}
Expand All @@ -109,8 +109,8 @@ Play around with all the CSS variables available in the slider component to see

You can use those to customize the component on both the `sx` prop and the theme.

:::info
💡 **Tip**: If you want to adjust a card's padding or border-radius, it's preferable to do it using the variables below instead of using CSS properties directly.
:::success
If you want to adjust a card's padding or border-radius, it's preferable to do it using the variables below instead of using CSS properties directly.
That's because the variables will also be used to calculate a proper radius for the card's children.
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/data/joy/components/checkbox/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For toggling between on and off or single option selection, consider using a swi

{{"demo": "CheckboxUsage.js", "hideToolbar": true, "bg": "gradient"}}

:::success
:::info
To learn how to add more variants or sizes to the component, check out the [Themed components](/joy-ui/customization/themed-components/) page.
:::

Expand Down Expand Up @@ -81,7 +81,7 @@ It's common to find it in tables where you have one checkbox that selects every
Use the `indeterminate` prop to circle around these states.

:::warning
**⚠️ Keep in mind:** When the indeterminate state is set, the value of the `checked` prop only impacts the form submitted values.
When the indeterminate state is set, the value of the `checked` prop only impacts the form submitted values.
It has no accessibility or UX implications.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/chip/chip.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The badge component is most frequently used to signal status (online, offline, b

{{"demo": "ChipUsage.js", "hideToolbar": true, "bg": "gradient"}}

:::success
:::info
To learn how to add more variants or sizes to the component, check out the [Themed components](/joy-ui/customization/themed-components/) page.
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The circular progress component comes with three sizes out of the box: `sm`, `md

{{"demo": "CircularProgressSizes.js"}}

:::success
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/data/joy/components/divider/divider.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export default function MyApp() {

Use the `Divider` to wrap elements that will be added to it.

:::info
♿️ **a11y tip**: When using the `Divider` component for visual decoration, such as in a heading, explicitly specify `role="presentation"` on it to make sure screen readers can announce its content:
:::warning
When using the `Divider` component for visual decoration, such as in a heading, explicitly specify `role="presentation"` on it to make sure screen readers can announce its content:

```js
<Divider component="div" role="presentation">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The linear progress component comes with three sizes out of the box: `sm`, `md`

{{"demo": "LinearProgressSizes.js"}}

:::success
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
6 changes: 3 additions & 3 deletions docs/data/joy/components/list/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Use the `size` prop to control font-size and general list density.

{{"demo": "SizesList.js"}}

:::success
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down Expand Up @@ -106,7 +106,7 @@ The nested list inherits the list `size` and a few other CSS variables, such as
{{"demo": "NestedList.js"}}

:::info
**Note:** By default, nested lists stick to the left of the root list.
By default, nested lists stick to the left of the root list.
To add spacing to the start of the nested list, use `--List-nestedInsetStart: ${value}`:

```js
Expand All @@ -120,7 +120,7 @@ To add spacing to the start of the nested list, use `--List-nestedInsetStart: ${
To show a list in a horizontal direction, use the `row` prop on the `List` component.

:::warning
**Note:** Nested lists don't work in the horizontal direction.
Nested lists don't work in the horizontal direction.
To do that, create a custom pop-up component instead (see the [Navigation menu](#navigation-menu) example).
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/components/menu/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ When specifying a size for the `Menu` component, menu items inside of it will in

{{"demo": "SizeMenu.js"}}

:::success
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::

Expand Down
6 changes: 2 additions & 4 deletions docs/data/joy/components/modal/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Joy UI provides three modal-related components:
{{"component": "modules/components/ComponentLinkHeader.js", "design": false}}

:::info
**Note:**
The term "modal" is sometimes used interchangeably with "dialog," but this is incorrect.

A modal [blocks interaction with the rest of the application](https://en.wikipedia.org/wiki/Modal_window), forcing the user to take action.
Expand Down Expand Up @@ -60,7 +59,7 @@ Use the `ModalClose` component to render a close button that inherits the modal'
{{"demo": "BasicModal.js"}}

:::info
💡 **Quick tip:** The `ModalClose` accepts the variant prop because it uses the same styles as the [`IconButton`](/joy-ui/react-button/#icon-button).
`ModalClose` accepts the variant prop because it uses the same styles as the [`IconButton`](/joy-ui/react-button/#icon-button).
:::

### Close reason
Expand Down Expand Up @@ -154,7 +153,6 @@ The modal components can be nested:
{{"demo": "NestedModals.js"}}

:::warning
⚠️ **Keep in mind:**
Though it is possible to create nested modals, stacking more than two at a time is discouraged.
This is because each successive modal blocks interaction with all elements behind it, making prior states inaccessible and overly complicated for the user to navigate through.
:::
Expand Down Expand Up @@ -216,7 +214,7 @@ See the [WAI-ARIA guide on the Dialog (Modal) pattern](https://www.w3.org/WAI/AR

- Follow the [WAI-ARIA authoring practices](https://www.w3.org/WAI/ARIA/apg/example-index/dialog-modal/dialog.html) to help you set the initial focus on the most relevant element based on the content of the modal.
:::warning
**Keep in mind:** A modal window can sit on top of either the parent application, or another modal window.
A modal window can sit on top of either the parent application, or another modal window.
_All_ windows under the topmost modal are **inert**, meaning the user cannot interact with them.
This can lead to [conflicting behaviors](#focus-trap).
:::
4 changes: 2 additions & 2 deletions docs/data/joy/components/radio/radio.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For more in-depth about when to use each, visit [the NNg's documentation](https:

{{"demo": "RadioUsage.js", "hideToolbar": true, "bg": "gradient"}}

:::success
:::info
To learn how to add more variants or sizes to the component, check out the [Themed components](/joy-ui/customization/themed-components/) page.
:::

Expand Down Expand Up @@ -90,7 +90,7 @@ You can also use it directly in the `RadioGroup` component as it will automatica
{{"demo": "OverlayRadio.js"}}

:::info
💡 **Tip:** Use the CSS variable `--Radio-action-radius` to control the border radius of the clickable area.
Use the CSS variable `--Radio-action-radius` to control the border radius of the clickable area.
:::

### Icon
Expand Down

0 comments on commit 845ac04

Please sign in to comment.