index
int64 0
0
| repo_id
stringlengths 16
181
| file_path
stringlengths 28
270
| content
stringlengths 1
11.6M
| __index_level_0__
int64 0
10k
|
|---|---|---|---|---|
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/list/SizesList.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import ListItemButton from '@mui/joy/ListItemButton';
import Typography from '@mui/joy/Typography';
import Home from '@mui/icons-material/Home';
export default function SizesList() {
return (
<Box
sx={{
flexGrow: 1,
display: 'flex',
justifyContent: 'center',
gap: 2,
flexWrap: 'wrap',
'& > *': { minWidth: 0, flexBasis: 200 },
}}
>
{['sm', 'md', 'lg'].map((size) => (
<div key={size}>
<Typography level="body-xs" mb={2}>
<code>size="{size}"</code>
</Typography>
<List
size={size}
variant="outlined"
sx={{
maxWidth: 300,
borderRadius: 'sm',
}}
>
<ListItem>
<ListItemButton>
<ListItemDecorator>
<Home />
</ListItemDecorator>
Home
</ListItemButton>
</ListItem>
<ListItem>
<ListItemButton>Projects</ListItemButton>
</ListItem>
<ListItem>
<ListItemButton>Settings</ListItemButton>
</ListItem>
</List>
</div>
))}
</Box>
);
}
| 1,300 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/list/SizesList.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import ListItemButton from '@mui/joy/ListItemButton';
import Typography from '@mui/joy/Typography';
import Home from '@mui/icons-material/Home';
export default function SizesList() {
return (
<Box
sx={{
flexGrow: 1,
display: 'flex',
justifyContent: 'center',
gap: 2,
flexWrap: 'wrap',
'& > *': { minWidth: 0, flexBasis: 200 },
}}
>
{(['sm', 'md', 'lg'] as const).map((size) => (
<div key={size}>
<Typography level="body-xs" mb={2}>
<code>size="{size}"</code>
</Typography>
<List
size={size}
variant="outlined"
sx={{
maxWidth: 300,
borderRadius: 'sm',
}}
>
<ListItem>
<ListItemButton>
<ListItemDecorator>
<Home />
</ListItemDecorator>
Home
</ListItemButton>
</ListItem>
<ListItem>
<ListItemButton>Projects</ListItemButton>
</ListItem>
<ListItem>
<ListItemButton>Settings</ListItemButton>
</ListItem>
</List>
</div>
))}
</Box>
);
}
| 1,301 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/list/StickyList.js | import * as React from 'react';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListSubheader from '@mui/joy/ListSubheader';
import ListItemButton from '@mui/joy/ListItemButton';
import Sheet from '@mui/joy/Sheet';
export default function StickyList() {
return (
<Sheet
variant="outlined"
sx={{
width: 320,
maxHeight: 300,
overflow: 'auto',
borderRadius: 'sm',
}}
>
<List>
{[...Array(5)].map((_, categoryIndex) => (
<ListItem nested key={categoryIndex}>
<ListSubheader sticky>Category {categoryIndex + 1}</ListSubheader>
<List>
{[...Array(10)].map((__, index) => (
<ListItem key={index}>
<ListItemButton>Subitem {index + 1}</ListItemButton>
</ListItem>
))}
</List>
</ListItem>
))}
</List>
</Sheet>
);
}
| 1,302 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/list/StickyList.tsx | import * as React from 'react';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListSubheader from '@mui/joy/ListSubheader';
import ListItemButton from '@mui/joy/ListItemButton';
import Sheet from '@mui/joy/Sheet';
export default function StickyList() {
return (
<Sheet
variant="outlined"
sx={{
width: 320,
maxHeight: 300,
overflow: 'auto',
borderRadius: 'sm',
}}
>
<List>
{[...Array(5)].map((_, categoryIndex) => (
<ListItem nested key={categoryIndex}>
<ListSubheader sticky>Category {categoryIndex + 1}</ListSubheader>
<List>
{[...Array(10)].map((__, index) => (
<ListItem key={index}>
<ListItemButton>Subitem {index + 1}</ListItemButton>
</ListItem>
))}
</List>
</ListItem>
))}
</List>
</Sheet>
);
}
| 1,303 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/list/list.md | ---
productId: joy-ui
title: React List component
components: List, ListDivider, ListItem, ListItemButton, ListItemContent, ListItemDecorator, ListSubheader
githubLabel: 'component: list'
---
# Lists
<p class="description">Lists are organizational tools that enhance the readability and organization of content.</p>
## Introduction
Lists present information in a concise, easy-to-follow format through a continuous, vertical index of text or images.
Joy UI Lists are implemented using a collection of related components:
- [List](#basics) - a wrapper for list items. Renders as a `<ul>` by default.
- [List Item](#basics) - a common list item. Renders as an `<li>` by default.
- [List Item Button](#interactive-list-items) - an action element to be used inside a list item.
- [List Item Decorator](#decorators) - a decorator of a list item, usually used to display an icon.
- [List Item Content](#ellipsis-content) - a container inside a list item, used to display text content.
- [List Divider](#divider) - a separator between list items.
- [List Subheader](#nested-list) - a label for a nested list.
{{"demo": "ListUsage.js", "hideToolbar": true, "bg": "gradient"}}
## Basics
```jsx
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
```
## Customization
### Variants
The List component supports Joy UI's four [global variants](/joy-ui/main-features/global-variants/): `solid`, `soft`, `outlined`, and `plain`.
### Sizes
The List component comes in three sizes: `sm`, `md`, and `lg`.
The size of the List determines its font size and density.
{{"demo": "SizesList.js"}}
:::info
To learn how to add custom sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::
### Colors
Every palette included in the theme is available via the `color` prop.
### Decorators
```jsx
import ListItemDecorator from '@mui/joy/ListItemDecorator';
```
Use the List Item Decorator component to add supporting icons or elements to the list item.
{{"demo": "DecoratedList.js"}}
:::info
The List Item Decorator comes with a minimum set width that can be adjusted using the `--list-decorator-size` CSS variable within the List component.
:::
### Horizontal list
Use the `orientation="horizontal"` prop on the List component to display the List horizontally.
{{"demo": "HorizontalList.js"}}
:::warning
While nested lists will not work in a horizontal direction, you can create a custom pop-up component to achieve a similar effect (see the [Navigation menu](#navigation-menu) example).
:::
### Semantic elements
Use the `component` prop to control which HTML tag is rendered.
```js
<List component="ol">
```
The example below renders the List component as an HTML `<nav>` element.
{{"demo": "NavList.js"}}
:::info
The List Item component is optional in this case.
If used, it will automatically change the semantic element from the default `<li>` to `<div>`.
:::
### Marker
Use the `marker` prop with any valid [list-style-type](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type) value to add a marker to the list items.
{{"demo": "MarkerList.js"}}
:::success
For [numbered lists](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ol), change the List component to `component="ol"`.
```js
<List component="ol" marker="decimal">
```
:::
### Ellipsis content
```jsx
import ListItemContent from '@mui/joy/ListItemContent';
```
When working with longer content in a List, you can use the List Item Content component in combination with `<Typography noWrap />` to display an ellipsis when the content exceeds the available space.
This can help to keep the List Items visually consistent and prevent text from overflowing outside of the List Item's container.
{{"demo": "EllipsisList.js"}}
### Divider
```jsx
import ListDivider from '@mui/joy/ListDivider';
```
The List Divider component comes with four `inset` patterns:
- Default (no `inset` prop provided): stretches form one edge of the List to the other.
- `inset="gutter"`: from the start of List Item Decorator to the end of the content.
- `inset="startDecorator"`: from the start of List Item Decorator to the end of the edge of the container.
- `inset="startContent"`: from the start of the content to the edge of the container.
{{"demo": "DividedList.js"}}
If you're using a horizontal list, only `inset="gutter"` will work as the list divider.
{{"demo": "HorizontalDividedList.js"}}
### Sticky item
Use the List component as a child of the Sheet component to create "sticky" items.
On the item you wish to stick, you can then add the `sticky` prop.
The Sheet component automatically adjusts the `sticky` list item to have the same background so that content does not overflow when scrolling.
{{"demo": "StickyList.js"}}
:::info
By default, this works on both light and dark modes.
:::
### Nested list
```jsx
import ListSubheader from '@mui/joy/ListSubheader';
```
You can create a nested list using the `nested` prop on a List Item.
This enables you to add a List Subheader as well as a new List component as children of the List Item.
The nested List will inherit its `size` as well as other CSS variables like `--List-radius` and `--ListItem-radius` from the root List component to keep the design consistent.
The layout and spacing of the nested List will remain independent.
{{"demo": "NestedList.js"}}
:::info
Nested lists will stick to the left of the root list, by default. If you need to add spacing to the start of the nested list you can use `--List-nestedInsetStart: ${value}`.
```js
<List sx={{ '--List-nestedInsetStart': '1rem' }}> {/* This is the root List */}
```
:::
### Interactive list items
```jsx
import ListItemButton from '@mui/joy/ListItemButton';
```
To make a List Item interactive, you can use List Item Button inside a List Item.
{{"demo": "ActionableList.js"}}
To add a secondary action to the List Item Button, wrap it in a List Item component and then add the desired start or end action elements to it.
{{"demo": "SecondaryList.js"}}
:::info
The List Item Button and the secondary action render as siblings so that the rendered semantic element is appropriately adjusted.
```js
<ul> {/* List */}
<li> {/* ListItem */}
<div role="button"> {/* ListItemButton */}
<button> {/* IconButton */}
```
:::
### Selected
Use the `selected` prop on the List Item Button component to indicate whether or not an item is currently selected.
When the item is selected, it applies `color="primary"` and a few extra styles—like font weight—to visually communicate the selected state.
{{"demo": "SelectedList.js"}}
:::info
A selected List Item Button does not apply `:hover` and `:active` global variant styles.
:::
## CSS variables playground
Play around with the CSS variables available to the List components to see how the design changes.
You can use these to customize the components with both the `sx` prop and the theme.
{{"demo": "ListVariables.js", "hideToolbar": true, "bg": "gradient"}}
## Common examples
### iOS settings
This example uses nested lists to split the settings into groups.
{{"demo": "ExampleIOSList.js"}}
### Gmail navigation
Inspired by Gmail's desktop navigation bar.
{{"demo": "ExampleGmailList.js"}}
### Collapsible list
Inspired by the [Gatsby documentation](https://www.gatsbyjs.com/docs) navbar.
This example uses the `startAction` prop to create a collapsible button.
{{"demo": "ExampleCollapsibleList.js"}}
### Navigation menu
Inspired by the [APG Navigation Menubar](https://www.w3.org/WAI/ARIA/apg/patterns/menubar/examples/menubar-navigation/) design pattern.
This example uses a combination of horizontal and vertical lists to form the navigation menu bar.
It also supports keyboard navigation, inspired by the [Roving UX](https://github.com/argyleink/roving-ux) technique.
{{"demo": "ExampleNavigationMenu.js"}}
## Accessibility
To ensure that your List is accessible, here are some factors you should consider:
- Use the appropriate HTML semantic element for the list (eg. `ol` or `ul`), to ensure that assistive technologies can correctly interpret the list structure.
- Make sure to use a meaningful name that describes the content of the list in the `aria-labelledby` prop.
- Use `role` attributes to provide additional information about the purpose of the list and its items.
For example, use `role="list"` for the list and `role="listitem"` for each list item.
## Anatomy
The List component is composed of a root `<ul>` element with one or more child `<li>` elements rendered by the List Item component.
All components nested inside the List Item are optional.
The [List Divider](#divider) (when present) renders an `<li>` with `role="separator"`, while the [List Subheader](#nested-list) renders a `<div>`.
```html
<ul class="MuiList-root">
<li class="MuiListItem-root">
<div class="MuiListItemButton-root" role="button">
<span class="MuiListItemDecorator-root">
<!-- Icon for List Item Decorator -->
</span>
<div class="MuiListItemContent-root">
<!-- List Item content -->
</div>
</div>
</li>
</ul>
```
| 1,304 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/AppsMenu.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import IconButton from '@mui/joy/IconButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import MenuButton from '@mui/joy/MenuButton';
import Apps from '@mui/icons-material/Apps';
import Dropdown from '@mui/joy/Dropdown';
export default function AppsMenu() {
return (
<Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'plain', color: 'neutral' } }}
sx={{ borderRadius: 40 }}
>
<Apps />
</MenuButton>
<Menu
variant="solid"
invertedColors
aria-labelledby="apps-menu-demo"
sx={{
'--List-padding': '0.5rem',
'--ListItemDecorator-size': '3rem',
display: 'grid',
gridTemplateColumns: 'repeat(3, 100px)',
gridAutoRows: '100px',
gap: 1,
}}
>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>S</Avatar>
</ListItemDecorator>
Search
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>M</Avatar>
</ListItemDecorator>
Maps
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>M</Avatar>
</ListItemDecorator>
Mail
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>D</Avatar>
</ListItemDecorator>
Drive
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>C</Avatar>
</ListItemDecorator>
Calendar
</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,305 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/AppsMenu.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import IconButton from '@mui/joy/IconButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import MenuButton from '@mui/joy/MenuButton';
import Apps from '@mui/icons-material/Apps';
import Dropdown from '@mui/joy/Dropdown';
export default function AppsMenu() {
return (
<Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'plain', color: 'neutral' } }}
sx={{ borderRadius: 40 }}
>
<Apps />
</MenuButton>
<Menu
variant="solid"
invertedColors
aria-labelledby="apps-menu-demo"
sx={{
'--List-padding': '0.5rem',
'--ListItemDecorator-size': '3rem',
display: 'grid',
gridTemplateColumns: 'repeat(3, 100px)',
gridAutoRows: '100px',
gap: 1,
}}
>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>S</Avatar>
</ListItemDecorator>
Search
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>M</Avatar>
</ListItemDecorator>
Maps
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>M</Avatar>
</ListItemDecorator>
Mail
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>D</Avatar>
</ListItemDecorator>
Drive
</MenuItem>
<MenuItem orientation="vertical">
<ListItemDecorator>
<Avatar>C</Avatar>
</ListItemDecorator>
Calendar
</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,306 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/BasicMenu.js | import * as React from 'react';
import Dropdown from '@mui/joy/Dropdown';
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
export default function BasicMenu() {
return (
<Dropdown>
<MenuButton>Dashboard...</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,307 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/BasicMenu.tsx | import * as React from 'react';
import Dropdown from '@mui/joy/Dropdown';
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
export default function BasicMenu() {
return (
<Dropdown>
<MenuButton>Dashboard...</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,308 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/BasicMenu.tsx.preview | <Dropdown>
<MenuButton>Dashboard...</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown> | 1,309 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/ControlledDropdown.js | import * as React from 'react';
import Dropdown from '@mui/joy/Dropdown';
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
export default function ControlledDropdown() {
const [open, setOpen] = React.useState(false);
const handleOpenChange = React.useCallback((event, isOpen) => {
setOpen(isOpen);
}, []);
return (
<Dropdown open={open} onOpenChange={handleOpenChange}>
<MenuButton>Dashboard...</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,310 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/ControlledDropdown.tsx | import * as React from 'react';
import Dropdown from '@mui/joy/Dropdown';
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
export default function ControlledDropdown() {
const [open, setOpen] = React.useState(false);
const handleOpenChange = React.useCallback(
(event: React.SyntheticEvent | null, isOpen: boolean) => {
setOpen(isOpen);
},
[],
);
return (
<Dropdown open={open} onOpenChange={handleOpenChange}>
<MenuButton>Dashboard...</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,311 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/ControlledDropdown.tsx.preview | <Dropdown open={open} onOpenChange={handleOpenChange}>
<MenuButton>Dashboard...</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown> | 1,312 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/GroupMenu.js | import * as React from 'react';
import MenuButton from '@mui/joy/MenuButton';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import ListDivider from '@mui/joy/ListDivider';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ArrowRight from '@mui/icons-material/ArrowRight';
import ArrowDropDown from '@mui/icons-material/ArrowDropDown';
import Dropdown from '@mui/joy/Dropdown';
export default function GroupMenu() {
const SIZES = ['X-Small', 'Small', 'Medium', 'Large', 'X-Large'];
const [size, setSize] = React.useState('Medium');
return (
<Dropdown>
<MenuButton endDecorator={<ArrowDropDown />}>Size</MenuButton>
<Menu sx={{ minWidth: 160, '--ListItemDecorator-size': '24px' }}>
<MenuItem
onClick={() => {
const nextIndex = SIZES.indexOf(size) - 1;
const value = nextIndex < 0 ? SIZES[SIZES.length - 1] : SIZES[nextIndex];
setSize(value);
}}
>
Smaller
</MenuItem>
<MenuItem
onClick={() => {
const nextIndex = SIZES.indexOf(size) + 1;
const value = nextIndex > SIZES.length - 1 ? SIZES[0] : SIZES[nextIndex];
setSize(value);
}}
>
Larger
</MenuItem>
<ListDivider />
<ListItem nested>
<List aria-label="Font sizes">
{SIZES.map((item) => (
<MenuItem
key={item}
role="menuitemradio"
aria-checked={item === size ? 'true' : 'false'}
onClick={() => {
setSize(item);
}}
>
<ListItemDecorator>
{item === size && <ArrowRight />}
</ListItemDecorator>{' '}
{item}
</MenuItem>
))}
</List>
</ListItem>
</Menu>
</Dropdown>
);
}
| 1,313 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/GroupMenu.tsx | import * as React from 'react';
import MenuButton from '@mui/joy/MenuButton';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import ListDivider from '@mui/joy/ListDivider';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ArrowRight from '@mui/icons-material/ArrowRight';
import ArrowDropDown from '@mui/icons-material/ArrowDropDown';
import Dropdown from '@mui/joy/Dropdown';
export default function GroupMenu() {
const SIZES = ['X-Small', 'Small', 'Medium', 'Large', 'X-Large'];
const [size, setSize] = React.useState('Medium');
return (
<Dropdown>
<MenuButton endDecorator={<ArrowDropDown />}>Size</MenuButton>
<Menu sx={{ minWidth: 160, '--ListItemDecorator-size': '24px' }}>
<MenuItem
onClick={() => {
const nextIndex = SIZES.indexOf(size) - 1;
const value = nextIndex < 0 ? SIZES[SIZES.length - 1] : SIZES[nextIndex];
setSize(value);
}}
>
Smaller
</MenuItem>
<MenuItem
onClick={() => {
const nextIndex = SIZES.indexOf(size) + 1;
const value = nextIndex > SIZES.length - 1 ? SIZES[0] : SIZES[nextIndex];
setSize(value);
}}
>
Larger
</MenuItem>
<ListDivider />
<ListItem nested>
<List aria-label="Font sizes">
{SIZES.map((item: string) => (
<MenuItem
key={item}
role="menuitemradio"
aria-checked={item === size ? 'true' : 'false'}
onClick={() => {
setSize(item);
}}
>
<ListItemDecorator>
{item === size && <ArrowRight />}
</ListItemDecorator>{' '}
{item}
</MenuItem>
))}
</List>
</ListItem>
</Menu>
</Dropdown>
);
}
| 1,314 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/IconButtonMenu.js | import * as React from 'react';
import Dropdown from '@mui/joy/Dropdown';
import IconButton from '@mui/joy/IconButton';
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
import MoreVert from '@mui/icons-material/MoreVert';
export default function IconButtonMenu() {
return (
<Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'outlined', color: 'neutral' } }}
>
<MoreVert />
</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,315 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/IconButtonMenu.tsx | import * as React from 'react';
import Dropdown from '@mui/joy/Dropdown';
import IconButton from '@mui/joy/IconButton';
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
import MoreVert from '@mui/icons-material/MoreVert';
export default function IconButtonMenu() {
return (
<Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'outlined', color: 'neutral' } }}
>
<MoreVert />
</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,316 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/IconButtonMenu.tsx.preview | <Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'outlined', color: 'neutral' } }}
>
<MoreVert />
</MenuButton>
<Menu>
<MenuItem>Profile</MenuItem>
<MenuItem>My account</MenuItem>
<MenuItem>Logout</MenuItem>
</Menu>
</Dropdown> | 1,317 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuIconSideNavExample.js | import * as React from 'react';
import PropTypes from 'prop-types';
import Menu, { menuClasses } from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import IconButton from '@mui/joy/IconButton';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import Sheet from '@mui/joy/Sheet';
import Apps from '@mui/icons-material/Apps';
import Settings from '@mui/icons-material/Settings';
import Person from '@mui/icons-material/Person';
import Dropdown from '@mui/joy/Dropdown';
import MenuButton from '@mui/joy/MenuButton';
// The Menu is built on top of Popper v2, so it accepts `modifiers` prop that will be passed to the Popper.
// https://popper.js.org/docs/v2/modifiers/offset/
const modifiers = [
{
name: 'offset',
options: {
offset: ({ placement }) => {
if (placement.includes('end')) {
return [8, 20];
}
return [-8, 20];
},
},
},
];
function NavMenuButton({
children,
menu,
open,
onOpen,
onLeaveMenu,
label,
...props
}) {
const isOnButton = React.useRef(false);
const internalOpen = React.useRef(open);
const handleButtonKeyDown = (event) => {
internalOpen.current = open;
if (event.key === 'ArrowDown' || event.key === 'ArrowUp') {
event.preventDefault();
onOpen(event);
}
};
return (
<Dropdown
open={open}
onOpenChange={(_, isOpen) => {
if (isOpen) {
onOpen?.();
}
}}
>
<MenuButton
{...props}
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'plain', color: 'neutral' } }}
onMouseDown={() => {
internalOpen.current = open;
}}
onClick={() => {
if (!internalOpen.current) {
onOpen();
}
}}
onMouseEnter={() => {
onOpen();
isOnButton.current = true;
}}
onMouseLeave={() => {
isOnButton.current = false;
}}
onKeyDown={handleButtonKeyDown}
sx={{
bgcolor: open ? 'neutral.plainHoverBg' : undefined,
'&:focus-visible': {
bgcolor: 'neutral.plainHoverBg',
},
}}
>
{children}
</MenuButton>
{React.cloneElement(menu, {
onMouseLeave: () => {
onLeaveMenu(() => isOnButton.current);
},
modifiers,
slotProps: {
listbox: {
id: `nav-example-menu-${label}`,
'aria-label': label,
},
},
placement: 'right-start',
sx: {
width: 288,
[`& .${menuClasses.listbox}`]: {
'--List-padding': 'var(--ListDivider-gap)',
},
},
})}
</Dropdown>
);
}
NavMenuButton.propTypes = {
children: PropTypes.node,
label: PropTypes.string.isRequired,
menu: PropTypes.element.isRequired,
onLeaveMenu: PropTypes.func.isRequired,
onOpen: PropTypes.func.isRequired,
open: PropTypes.bool.isRequired,
};
export default function MenuIconSideNavExample() {
const [menuIndex, setMenuIndex] = React.useState(null);
const itemProps = {
onClick: () => setMenuIndex(null),
};
const createHandleLeaveMenu = (index) => (getIsOnButton) => {
setTimeout(() => {
const isOnButton = getIsOnButton();
if (!isOnButton) {
setMenuIndex((latestIndex) => {
if (index === latestIndex) {
return null;
}
return latestIndex;
});
}
}, 200);
};
return (
<Sheet sx={{ borderRadius: 'sm', py: 1, mr: 20 }}>
<List>
<ListItem>
<NavMenuButton
label="Apps"
open={menuIndex === 0}
onOpen={() => setMenuIndex(0)}
onLeaveMenu={createHandleLeaveMenu(0)}
menu={
<Menu onClose={() => setMenuIndex(null)}>
<MenuItem {...itemProps}>Application 1</MenuItem>
<MenuItem {...itemProps}>Application 2</MenuItem>
<MenuItem {...itemProps}>Application 3</MenuItem>
</Menu>
}
>
<Apps />
</NavMenuButton>
</ListItem>
<ListItem>
<NavMenuButton
label="Settings"
open={menuIndex === 1}
onOpen={() => setMenuIndex(1)}
onLeaveMenu={createHandleLeaveMenu(1)}
menu={
<Menu onClose={() => setMenuIndex(null)}>
<MenuItem {...itemProps}>Setting 1</MenuItem>
<MenuItem {...itemProps}>Setting 2</MenuItem>
<MenuItem {...itemProps}>Setting 3</MenuItem>
</Menu>
}
>
<Settings />
</NavMenuButton>
</ListItem>
<ListItem>
<NavMenuButton
label="Personal"
open={menuIndex === 2}
onOpen={() => setMenuIndex(2)}
onLeaveMenu={createHandleLeaveMenu(2)}
menu={
<Menu onClose={() => setMenuIndex(null)}>
<MenuItem {...itemProps}>Personal 1</MenuItem>
<MenuItem {...itemProps}>Personal 2</MenuItem>
<MenuItem {...itemProps}>Personal 3</MenuItem>
</Menu>
}
>
<Person />
</NavMenuButton>
</ListItem>
</List>
</Sheet>
);
}
| 1,318 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuIconSideNavExample.tsx | import * as React from 'react';
import Menu, { menuClasses } from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import IconButton from '@mui/joy/IconButton';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import Sheet from '@mui/joy/Sheet';
import Apps from '@mui/icons-material/Apps';
import Settings from '@mui/icons-material/Settings';
import Person from '@mui/icons-material/Person';
import Dropdown from '@mui/joy/Dropdown';
import MenuButton from '@mui/joy/MenuButton';
// The Menu is built on top of Popper v2, so it accepts `modifiers` prop that will be passed to the Popper.
// https://popper.js.org/docs/v2/modifiers/offset/
interface MenuButtonProps extends React.HTMLAttributes<HTMLButtonElement> {
children: React.ReactNode;
menu: React.ReactElement;
open: boolean;
onOpen: (
event?:
| React.MouseEvent<HTMLButtonElement>
| React.KeyboardEvent<HTMLButtonElement>,
) => void;
onLeaveMenu: (callback: () => boolean) => void;
label: string;
}
const modifiers = [
{
name: 'offset',
options: {
offset: ({ placement }: any) => {
if (placement.includes('end')) {
return [8, 20];
}
return [-8, 20];
},
},
},
];
function NavMenuButton({
children,
menu,
open,
onOpen,
onLeaveMenu,
label,
...props
}: Omit<MenuButtonProps, 'color'>) {
const isOnButton = React.useRef(false);
const internalOpen = React.useRef(open);
const handleButtonKeyDown = (event: React.KeyboardEvent<HTMLButtonElement>) => {
internalOpen.current = open;
if (event.key === 'ArrowDown' || event.key === 'ArrowUp') {
event.preventDefault();
onOpen(event);
}
};
return (
<Dropdown
open={open}
onOpenChange={(_, isOpen) => {
if (isOpen) {
onOpen?.();
}
}}
>
<MenuButton
{...props}
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'plain', color: 'neutral' } }}
onMouseDown={() => {
internalOpen.current = open;
}}
onClick={() => {
if (!internalOpen.current) {
onOpen();
}
}}
onMouseEnter={() => {
onOpen();
isOnButton.current = true;
}}
onMouseLeave={() => {
isOnButton.current = false;
}}
onKeyDown={handleButtonKeyDown}
sx={{
bgcolor: open ? 'neutral.plainHoverBg' : undefined,
'&:focus-visible': {
bgcolor: 'neutral.plainHoverBg',
},
}}
>
{children}
</MenuButton>
{React.cloneElement(menu, {
onMouseLeave: () => {
onLeaveMenu(() => isOnButton.current);
},
modifiers,
slotProps: {
listbox: {
id: `nav-example-menu-${label}`,
'aria-label': label,
},
},
placement: 'right-start',
sx: {
width: 288,
[`& .${menuClasses.listbox}`]: {
'--List-padding': 'var(--ListDivider-gap)',
},
},
})}
</Dropdown>
);
}
export default function MenuIconSideNavExample() {
const [menuIndex, setMenuIndex] = React.useState<null | number>(null);
const itemProps = {
onClick: () => setMenuIndex(null),
};
const createHandleLeaveMenu =
(index: number) => (getIsOnButton: () => boolean) => {
setTimeout(() => {
const isOnButton = getIsOnButton();
if (!isOnButton) {
setMenuIndex((latestIndex: null | number) => {
if (index === latestIndex) {
return null;
}
return latestIndex;
});
}
}, 200);
};
return (
<Sheet sx={{ borderRadius: 'sm', py: 1, mr: 20 }}>
<List>
<ListItem>
<NavMenuButton
label="Apps"
open={menuIndex === 0}
onOpen={() => setMenuIndex(0)}
onLeaveMenu={createHandleLeaveMenu(0)}
menu={
<Menu onClose={() => setMenuIndex(null)}>
<MenuItem {...itemProps}>Application 1</MenuItem>
<MenuItem {...itemProps}>Application 2</MenuItem>
<MenuItem {...itemProps}>Application 3</MenuItem>
</Menu>
}
>
<Apps />
</NavMenuButton>
</ListItem>
<ListItem>
<NavMenuButton
label="Settings"
open={menuIndex === 1}
onOpen={() => setMenuIndex(1)}
onLeaveMenu={createHandleLeaveMenu(1)}
menu={
<Menu onClose={() => setMenuIndex(null)}>
<MenuItem {...itemProps}>Setting 1</MenuItem>
<MenuItem {...itemProps}>Setting 2</MenuItem>
<MenuItem {...itemProps}>Setting 3</MenuItem>
</Menu>
}
>
<Settings />
</NavMenuButton>
</ListItem>
<ListItem>
<NavMenuButton
label="Personal"
open={menuIndex === 2}
onOpen={() => setMenuIndex(2)}
onLeaveMenu={createHandleLeaveMenu(2)}
menu={
<Menu onClose={() => setMenuIndex(null)}>
<MenuItem {...itemProps}>Personal 1</MenuItem>
<MenuItem {...itemProps}>Personal 2</MenuItem>
<MenuItem {...itemProps}>Personal 3</MenuItem>
</Menu>
}
>
<Person />
</NavMenuButton>
</ListItem>
</List>
</Sheet>
);
}
| 1,319 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuListComposition.js | import * as React from 'react';
import { Popper } from '@mui/base/Popper';
import { ClickAwayListener } from '@mui/base/ClickAwayListener';
import { styled } from '@mui/joy/styles';
import Button from '@mui/joy/Button';
import MenuList from '@mui/joy/MenuList';
import MenuItem from '@mui/joy/MenuItem';
const Popup = styled(Popper)({
zIndex: 1000,
});
export default function MenuListComposition() {
const buttonRef = React.useRef(null);
const [open, setOpen] = React.useState(false);
const handleClose = () => {
setOpen(false);
};
const handleListKeyDown = (event) => {
if (event.key === 'Tab') {
setOpen(false);
} else if (event.key === 'Escape') {
buttonRef.current.focus();
setOpen(false);
}
};
return (
<div>
<Button
ref={buttonRef}
id="composition-button"
aria-controls={'composition-menu'}
aria-haspopup="true"
aria-expanded={open ? 'true' : undefined}
variant="outlined"
color="neutral"
onClick={() => {
setOpen(!open);
}}
>
Open menu
</Button>
<Popup
role={undefined}
id="composition-menu"
open={open}
anchorEl={buttonRef.current}
disablePortal
modifiers={[
{
name: 'offset',
options: {
offset: [0, 4],
},
},
]}
>
<ClickAwayListener
onClickAway={(event) => {
if (event.target !== buttonRef.current) {
handleClose();
}
}}
>
<MenuList
variant="outlined"
onKeyDown={handleListKeyDown}
sx={{ boxShadow: 'md' }}
>
<MenuItem onClick={handleClose}>Single</MenuItem>
<MenuItem onClick={handleClose}>1.15</MenuItem>
<MenuItem onClick={handleClose}>Double</MenuItem>
<MenuItem onClick={handleClose}>Custom: 1.2</MenuItem>
</MenuList>
</ClickAwayListener>
</Popup>
</div>
);
}
| 1,320 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuListComposition.tsx | import * as React from 'react';
import { Popper } from '@mui/base/Popper';
import { ClickAwayListener } from '@mui/base/ClickAwayListener';
import { styled } from '@mui/joy/styles';
import Button from '@mui/joy/Button';
import MenuList from '@mui/joy/MenuList';
import MenuItem from '@mui/joy/MenuItem';
const Popup = styled(Popper)({
zIndex: 1000,
});
export default function MenuListComposition() {
const buttonRef = React.useRef<HTMLButtonElement>(null);
const [open, setOpen] = React.useState(false);
const handleClose = () => {
setOpen(false);
};
const handleListKeyDown = (event: React.KeyboardEvent<HTMLElement>) => {
if (event.key === 'Tab') {
setOpen(false);
} else if (event.key === 'Escape') {
buttonRef.current!.focus();
setOpen(false);
}
};
return (
<div>
<Button
ref={buttonRef}
id="composition-button"
aria-controls={'composition-menu'}
aria-haspopup="true"
aria-expanded={open ? 'true' : undefined}
variant="outlined"
color="neutral"
onClick={() => {
setOpen(!open);
}}
>
Open menu
</Button>
<Popup
role={undefined}
id="composition-menu"
open={open}
anchorEl={buttonRef.current}
disablePortal
modifiers={[
{
name: 'offset',
options: {
offset: [0, 4],
},
},
]}
>
<ClickAwayListener
onClickAway={(event) => {
if (event.target !== buttonRef.current) {
handleClose();
}
}}
>
<MenuList
variant="outlined"
onKeyDown={handleListKeyDown}
sx={{ boxShadow: 'md' }}
>
<MenuItem onClick={handleClose}>Single</MenuItem>
<MenuItem onClick={handleClose}>1.15</MenuItem>
<MenuItem onClick={handleClose}>Double</MenuItem>
<MenuItem onClick={handleClose}>Custom: 1.2</MenuItem>
</MenuList>
</ClickAwayListener>
</Popup>
</div>
);
}
| 1,321 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuListGroup.js | import * as React from 'react';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import MenuList from '@mui/joy/MenuList';
import MenuItem from '@mui/joy/MenuItem';
import Typography from '@mui/joy/Typography';
export default function MenuListGroup() {
return (
<MenuList
component="div"
variant="outlined"
size="sm"
sx={{
boxShadow: 'sm',
flexGrow: 0,
minWidth: 200,
maxHeight: 240,
overflow: 'auto',
}}
>
{[...Array(5)].map((_, categoryIndex) => (
<List key={categoryIndex}>
<ListItem sticky>
<Typography
id={`sticky-list-demo-${categoryIndex}`}
level="body-xs"
textTransform="uppercase"
fontWeight="lg"
>
Category {categoryIndex + 1}
</Typography>
</ListItem>
{[...Array(10)].map((__, index) => (
<MenuItem key={index}>Action {index + 1}</MenuItem>
))}
</List>
))}
</MenuList>
);
}
| 1,322 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuListGroup.tsx | import * as React from 'react';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import MenuList from '@mui/joy/MenuList';
import MenuItem from '@mui/joy/MenuItem';
import Typography from '@mui/joy/Typography';
export default function MenuListGroup() {
return (
<MenuList
component="div"
variant="outlined"
size="sm"
sx={{
boxShadow: 'sm',
flexGrow: 0,
minWidth: 200,
maxHeight: 240,
overflow: 'auto',
}}
>
{[...Array(5)].map((_, categoryIndex) => (
<List key={categoryIndex}>
<ListItem sticky>
<Typography
id={`sticky-list-demo-${categoryIndex}`}
level="body-xs"
textTransform="uppercase"
fontWeight="lg"
>
Category {categoryIndex + 1}
</Typography>
</ListItem>
{[...Array(10)].map((__, index) => (
<MenuItem key={index}>Action {index + 1}</MenuItem>
))}
</List>
))}
</MenuList>
);
}
| 1,323 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuToolbarExample.js | import * as React from 'react';
import Menu from '@mui/joy/Menu';
import MenuItem, { menuItemClasses } from '@mui/joy/MenuItem';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListItemButton from '@mui/joy/ListItemButton';
import ListDivider from '@mui/joy/ListDivider';
import Typography, { typographyClasses } from '@mui/joy/Typography';
import Dropdown from '@mui/joy/Dropdown';
import MenuButton from '@mui/joy/MenuButton';
const MenuBarButton = React.forwardRef(
({ children, menu, open, onOpen, onKeyDown, ...props }, ref) => {
return (
<Dropdown open={open} onOpenChange={onOpen}>
<MenuButton
{...props}
slots={{ root: ListItemButton }}
ref={ref}
role="menuitem"
variant={open ? 'soft' : 'plain'}
>
{children}
</MenuButton>
{React.cloneElement(menu, {
slotProps: {
listbox: {
id: `toolbar-example-menu-${children}`,
'aria-label': children,
},
},
placement: 'bottom-start',
disablePortal: false,
variant: 'soft',
sx: (theme) => ({
width: 288,
boxShadow: '0 2px 8px 0px rgba(0 0 0 / 0.38)',
'--List-padding': 'var(--ListDivider-gap)',
'--ListItem-minHeight': '32px',
[`&& .${menuItemClasses.root}`]: {
transition: 'none',
'&:hover': {
...theme.variants.solid.primary,
[`& .${typographyClasses.root}`]: {
color: 'inherit',
},
},
},
}),
})}
</Dropdown>
);
},
);
export default function MenuToolbarExample() {
const menus = React.useRef([]);
const [menuIndex, setMenuIndex] = React.useState(null);
const renderShortcut = (text) => (
<Typography level="body-sm" textColor="text.tertiary" ml="auto">
{text}
</Typography>
);
const openNextMenu = () => {
if (typeof menuIndex === 'number') {
if (menuIndex === menus.current.length - 1) {
setMenuIndex(0);
} else {
setMenuIndex(menuIndex + 1);
}
}
};
const openPreviousMenu = () => {
if (typeof menuIndex === 'number') {
if (menuIndex === 0) {
setMenuIndex(menus.current.length - 1);
} else {
setMenuIndex(menuIndex - 1);
}
}
};
const handleKeyDown = (event) => {
if (event.key === 'ArrowRight') {
openNextMenu();
}
if (event.key === 'ArrowLeft') {
openPreviousMenu();
}
};
const createHandleButtonKeyDown = (index) => (event) => {
if (event.key === 'ArrowRight') {
if (index === menus.current.length - 1) {
menus.current[0]?.focus();
} else {
menus.current[index + 1]?.focus();
}
}
if (event.key === 'ArrowLeft') {
if (index === 0) {
menus.current[menus.current.length]?.focus();
} else {
menus.current[index - 1]?.focus();
}
}
};
const itemProps = {
onClick: () => setMenuIndex(null),
onKeyDown: handleKeyDown,
};
return (
<List
orientation="horizontal"
aria-label="Example application menu bar"
role="menubar"
data-joy-color-scheme="dark"
sx={{
bgcolor: 'background.body',
borderRadius: '4px',
maxWidth: 'fit-content',
}}
>
<ListItem>
<MenuBarButton
open={menuIndex === 0}
onOpen={() => {
setMenuIndex((prevMenuIndex) => (prevMenuIndex === null ? 0 : null));
}}
onKeyDown={createHandleButtonKeyDown(0)}
onMouseEnter={() => {
if (typeof menuIndex === 'number') {
setMenuIndex(0);
}
}}
ref={(instance) => {
menus.current[0] = instance;
}}
menu={
<Menu
onClose={() => {
menus.current[0]?.focus();
}}
>
<ListItem nested>
<List aria-label="New">
<MenuItem {...itemProps}>New File</MenuItem>
<MenuItem {...itemProps}>
New Text File... {renderShortcut('⌥ ⌘ N')}
</MenuItem>
<MenuItem {...itemProps}>
New Window {renderShortcut('⇧ ⌘ N')}
</MenuItem>
</List>
</ListItem>
<ListDivider />
<ListItem nested>
<List aria-label="Open">
<MenuItem {...itemProps}>Open {renderShortcut('⌘ O')}</MenuItem>
<MenuItem {...itemProps}>Open Folder</MenuItem>
</List>
</ListItem>
</Menu>
}
>
File
</MenuBarButton>
</ListItem>
<ListItem>
<MenuBarButton
open={menuIndex === 1}
onOpen={() => {
setMenuIndex((prevMenuIndex) => (prevMenuIndex === null ? 1 : null));
}}
onKeyDown={createHandleButtonKeyDown(1)}
onMouseEnter={() => {
if (typeof menuIndex === 'number') {
setMenuIndex(1);
}
}}
ref={(instance) => {
menus.current[1] = instance;
}}
menu={
<Menu
onClose={() => {
menus.current[1]?.focus();
}}
>
<ListItem nested>
<List aria-label="Time travel">
<MenuItem {...itemProps}>Undo {renderShortcut('⌘ Z')}</MenuItem>
<MenuItem {...itemProps}>Redo {renderShortcut('⇧ ⌘ Z')}</MenuItem>
</List>
</ListItem>
<ListDivider />
<ListItem nested>
<List aria-label="Tool">
<MenuItem {...itemProps}>Cut {renderShortcut('⌘ X')}</MenuItem>
<MenuItem {...itemProps}>Copy {renderShortcut('⌘ Z')}</MenuItem>
<MenuItem {...itemProps}>Paste {renderShortcut('⌘ V')}</MenuItem>
</List>
</ListItem>
</Menu>
}
>
Edit
</MenuBarButton>
</ListItem>
<ListItem>
<MenuBarButton
open={menuIndex === 2}
onOpen={() => {
setMenuIndex((prevMenuIndex) => (prevMenuIndex === null ? 2 : null));
}}
onKeyDown={createHandleButtonKeyDown(2)}
onMouseEnter={() => {
if (typeof menuIndex === 'number') {
setMenuIndex(2);
}
}}
ref={(instance) => {
menus.current[2] = instance;
}}
menu={
<Menu
onClose={() => {
menus.current[2]?.focus();
}}
>
<MenuItem {...itemProps}>Select All {renderShortcut('⌘ A')}</MenuItem>
<MenuItem {...itemProps}>
Expand Selection {renderShortcut('⌃ ⇧ ⌘ →')}
</MenuItem>
<MenuItem {...itemProps}>
Shrink Selection {renderShortcut('⌃ ⇧ ⌘ ←')}
</MenuItem>
</Menu>
}
>
Selection
</MenuBarButton>
</ListItem>
</List>
);
}
| 1,324 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuToolbarExample.tsx | import * as React from 'react';
import Menu from '@mui/joy/Menu';
import MenuItem, { menuItemClasses } from '@mui/joy/MenuItem';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListItemButton from '@mui/joy/ListItemButton';
import ListDivider from '@mui/joy/ListDivider';
import Typography, { typographyClasses } from '@mui/joy/Typography';
import Dropdown, { DropdownProps } from '@mui/joy/Dropdown';
import MenuButton from '@mui/joy/MenuButton';
import { Theme } from '@mui/joy';
type MenuBarButtonProps = Pick<DropdownProps, 'children' | 'open'> & {
onOpen: DropdownProps['onOpenChange'];
onKeyDown: React.KeyboardEventHandler;
menu: JSX.Element;
onMouseEnter: React.MouseEventHandler;
};
const MenuBarButton = React.forwardRef(
(
{ children, menu, open, onOpen, onKeyDown, ...props }: MenuBarButtonProps,
ref: React.ForwardedRef<HTMLButtonElement>,
) => {
return (
<Dropdown open={open} onOpenChange={onOpen}>
<MenuButton
{...props}
slots={{ root: ListItemButton }}
ref={ref}
role="menuitem"
variant={open ? 'soft' : 'plain'}
>
{children}
</MenuButton>
{React.cloneElement(menu, {
slotProps: {
listbox: {
id: `toolbar-example-menu-${children}`,
'aria-label': children,
},
},
placement: 'bottom-start',
disablePortal: false,
variant: 'soft',
sx: (theme: Theme) => ({
width: 288,
boxShadow: '0 2px 8px 0px rgba(0 0 0 / 0.38)',
'--List-padding': 'var(--ListDivider-gap)',
'--ListItem-minHeight': '32px',
[`&& .${menuItemClasses.root}`]: {
transition: 'none',
'&:hover': {
...theme.variants.solid.primary,
[`& .${typographyClasses.root}`]: {
color: 'inherit',
},
},
},
}),
})}
</Dropdown>
);
},
);
export default function MenuToolbarExample() {
const menus = React.useRef<Array<HTMLButtonElement>>([]);
const [menuIndex, setMenuIndex] = React.useState<null | number>(null);
const renderShortcut = (text: string) => (
<Typography level="body-sm" textColor="text.tertiary" ml="auto">
{text}
</Typography>
);
const openNextMenu = () => {
if (typeof menuIndex === 'number') {
if (menuIndex === menus.current.length - 1) {
setMenuIndex(0);
} else {
setMenuIndex(menuIndex + 1);
}
}
};
const openPreviousMenu = () => {
if (typeof menuIndex === 'number') {
if (menuIndex === 0) {
setMenuIndex(menus.current.length - 1);
} else {
setMenuIndex(menuIndex - 1);
}
}
};
const handleKeyDown = (event: React.KeyboardEvent) => {
if (event.key === 'ArrowRight') {
openNextMenu();
}
if (event.key === 'ArrowLeft') {
openPreviousMenu();
}
};
const createHandleButtonKeyDown =
(index: number) => (event: React.KeyboardEvent) => {
if (event.key === 'ArrowRight') {
if (index === menus.current.length - 1) {
menus.current[0]?.focus();
} else {
menus.current[index + 1]?.focus();
}
}
if (event.key === 'ArrowLeft') {
if (index === 0) {
menus.current[menus.current.length]?.focus();
} else {
menus.current[index - 1]?.focus();
}
}
};
const itemProps = {
onClick: () => setMenuIndex(null),
onKeyDown: handleKeyDown,
};
return (
<List
orientation="horizontal"
aria-label="Example application menu bar"
role="menubar"
data-joy-color-scheme="dark"
sx={{
bgcolor: 'background.body',
borderRadius: '4px',
maxWidth: 'fit-content',
}}
>
<ListItem>
<MenuBarButton
open={menuIndex === 0}
onOpen={() => {
setMenuIndex((prevMenuIndex) => (prevMenuIndex === null ? 0 : null));
}}
onKeyDown={createHandleButtonKeyDown(0)}
onMouseEnter={() => {
if (typeof menuIndex === 'number') {
setMenuIndex(0);
}
}}
ref={(instance) => {
menus.current[0] = instance!;
}}
menu={
<Menu
onClose={() => {
menus.current[0]?.focus();
}}
>
<ListItem nested>
<List aria-label="New">
<MenuItem {...itemProps}>New File</MenuItem>
<MenuItem {...itemProps}>
New Text File... {renderShortcut('⌥ ⌘ N')}
</MenuItem>
<MenuItem {...itemProps}>
New Window {renderShortcut('⇧ ⌘ N')}
</MenuItem>
</List>
</ListItem>
<ListDivider />
<ListItem nested>
<List aria-label="Open">
<MenuItem {...itemProps}>Open {renderShortcut('⌘ O')}</MenuItem>
<MenuItem {...itemProps}>Open Folder</MenuItem>
</List>
</ListItem>
</Menu>
}
>
File
</MenuBarButton>
</ListItem>
<ListItem>
<MenuBarButton
open={menuIndex === 1}
onOpen={() => {
setMenuIndex((prevMenuIndex) => (prevMenuIndex === null ? 1 : null));
}}
onKeyDown={createHandleButtonKeyDown(1)}
onMouseEnter={() => {
if (typeof menuIndex === 'number') {
setMenuIndex(1);
}
}}
ref={(instance) => {
menus.current[1] = instance!;
}}
menu={
<Menu
onClose={() => {
menus.current[1]?.focus();
}}
>
<ListItem nested>
<List aria-label="Time travel">
<MenuItem {...itemProps}>Undo {renderShortcut('⌘ Z')}</MenuItem>
<MenuItem {...itemProps}>Redo {renderShortcut('⇧ ⌘ Z')}</MenuItem>
</List>
</ListItem>
<ListDivider />
<ListItem nested>
<List aria-label="Tool">
<MenuItem {...itemProps}>Cut {renderShortcut('⌘ X')}</MenuItem>
<MenuItem {...itemProps}>Copy {renderShortcut('⌘ Z')}</MenuItem>
<MenuItem {...itemProps}>Paste {renderShortcut('⌘ V')}</MenuItem>
</List>
</ListItem>
</Menu>
}
>
Edit
</MenuBarButton>
</ListItem>
<ListItem>
<MenuBarButton
open={menuIndex === 2}
onOpen={() => {
setMenuIndex((prevMenuIndex) => (prevMenuIndex === null ? 2 : null));
}}
onKeyDown={createHandleButtonKeyDown(2)}
onMouseEnter={() => {
if (typeof menuIndex === 'number') {
setMenuIndex(2);
}
}}
ref={(instance) => {
menus.current[2] = instance!;
}}
menu={
<Menu
onClose={() => {
menus.current[2]?.focus();
}}
>
<MenuItem {...itemProps}>Select All {renderShortcut('⌘ A')}</MenuItem>
<MenuItem {...itemProps}>
Expand Selection {renderShortcut('⌃ ⇧ ⌘ →')}
</MenuItem>
<MenuItem {...itemProps}>
Shrink Selection {renderShortcut('⌃ ⇧ ⌘ ←')}
</MenuItem>
</Menu>
}
>
Selection
</MenuBarButton>
</ListItem>
</List>
);
}
| 1,325 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/MenuUsage.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import MenuButton from '@mui/joy/MenuButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ListDivider from '@mui/joy/ListDivider';
import Dropdown from '@mui/joy/Dropdown';
import JoyUsageDemo from 'docs/src/modules/components/JoyUsageDemo';
export default function MenuUsage() {
return (
<JoyUsageDemo
componentName="Menu"
data={[
{
propName: 'menuButtonVariant',
knob: 'select',
defaultValue: 'outlined',
options: ['plain', 'outlined', 'soft', 'solid'],
},
{
propName: 'menuVariant',
knob: 'select',
defaultValue: 'outlined',
options: ['plain', 'outlined', 'soft', 'solid'],
},
{
propName: 'color',
knob: 'color',
defaultValue: 'neutral',
},
{
propName: 'size',
knob: 'radio',
options: ['sm', 'md', 'lg'],
defaultValue: 'md',
},
{
propName: 'open',
knob: 'controlled',
},
{
propName: 'invertedColors',
knob: 'switch',
},
{
propName: 'children',
defaultValue: '$children',
},
]}
getCodeBlock={(code, props) => {
return `<Dropdown${props.open ? ` open` : ''}>
<MenuButton${
props.menuButtonVariant !== 'outlined'
? `
variant="${props.menuButtonVariant}"`
: ''
}${
props.color !== 'neutral'
? `
color="${props.color}"`
: ''
}${
props.size !== 'md'
? `
size="${props.size}"`
: ''
}>
Format
</MenuButton>
<Menu${
props.invertedColors
? `
invertedColors`
: ''
}${
props.menuVariant !== 'outlined'
? `
variant="${props.menuVariant}"`
: ''
}${
props.color !== 'neutral'
? `
color="${props.color}"`
: ''
}${
props.size !== 'md'
? `
size="${props.size}"`
: ''
}>
<MenuItem>…</MenuItem>
…
</Menu>
</Dropdown>`;
}}
renderDemo={({
menuButtonVariant,
menuVariant,
color,
open,
size,
invertedColors,
}) => (
<Box sx={{ pb: 20 }}>
<Dropdown open={open}>
<MenuButton variant={menuButtonVariant} color={color} size={size}>
Format
</MenuButton>
<Menu
variant={menuVariant}
color={color}
size={size}
invertedColors={invertedColors}
>
<MenuItem>Add space before paragraph</MenuItem>
<MenuItem>Add space after paragraph</MenuItem>
<ListDivider />
<MenuItem>Custom spacing...</MenuItem>
</Menu>
</Dropdown>
</Box>
)}
/>
);
}
| 1,326 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/PositionedMenu.js | import * as React from 'react';
import IconButton from '@mui/joy/IconButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import ListDivider from '@mui/joy/ListDivider';
import MoreVert from '@mui/icons-material/MoreVert';
import Edit from '@mui/icons-material/Edit';
import DeleteForever from '@mui/icons-material/DeleteForever';
import MenuButton from '@mui/joy/MenuButton';
import Dropdown from '@mui/joy/Dropdown';
export default function PositionedMenu() {
return (
<Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'outlined', color: 'neutral' } }}
>
<MoreVert />
</MenuButton>
<Menu placement="bottom-end">
<MenuItem>
<ListItemDecorator>
<Edit />
</ListItemDecorator>{' '}
Edit post
</MenuItem>
<MenuItem disabled>
<ListItemDecorator />
Draft post
</MenuItem>
<ListDivider />
<MenuItem variant="soft" color="danger">
<ListItemDecorator sx={{ color: 'inherit' }}>
<DeleteForever />
</ListItemDecorator>{' '}
Delete
</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,327 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/PositionedMenu.tsx | import * as React from 'react';
import IconButton from '@mui/joy/IconButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import ListDivider from '@mui/joy/ListDivider';
import MoreVert from '@mui/icons-material/MoreVert';
import Edit from '@mui/icons-material/Edit';
import DeleteForever from '@mui/icons-material/DeleteForever';
import MenuButton from '@mui/joy/MenuButton';
import Dropdown from '@mui/joy/Dropdown';
export default function PositionedMenu() {
return (
<Dropdown>
<MenuButton
slots={{ root: IconButton }}
slotProps={{ root: { variant: 'outlined', color: 'neutral' } }}
>
<MoreVert />
</MenuButton>
<Menu placement="bottom-end">
<MenuItem>
<ListItemDecorator>
<Edit />
</ListItemDecorator>{' '}
Edit post
</MenuItem>
<MenuItem disabled>
<ListItemDecorator />
Draft post
</MenuItem>
<ListDivider />
<MenuItem variant="soft" color="danger">
<ListItemDecorator sx={{ color: 'inherit' }}>
<DeleteForever />
</ListItemDecorator>{' '}
Delete
</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,328 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/SelectedMenu.js | import * as React from 'react';
import MenuButton from '@mui/joy/MenuButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import Apps from '@mui/icons-material/Apps';
import Dropdown from '@mui/joy/Dropdown';
export default function SelectedMenu() {
const [selectedIndex, setSelectedIndex] = React.useState(1);
const createHandleClose = (index) => () => {
if (typeof index === 'number') {
setSelectedIndex(index);
}
};
return (
<Dropdown>
<MenuButton startDecorator={<Apps />}>Apps</MenuButton>
<Menu>
<MenuItem
{...(selectedIndex === 0 && { selected: true, variant: 'soft' })}
onClick={createHandleClose(0)}
>
Random project
</MenuItem>
<MenuItem selected={selectedIndex === 1} onClick={createHandleClose(1)}>
Production - web
</MenuItem>
<MenuItem selected={selectedIndex === 2} onClick={createHandleClose(2)}>
Staging - web
</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,329 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/SelectedMenu.tsx | import * as React from 'react';
import MenuButton from '@mui/joy/MenuButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import Apps from '@mui/icons-material/Apps';
import Dropdown from '@mui/joy/Dropdown';
export default function SelectedMenu() {
const [selectedIndex, setSelectedIndex] = React.useState<number>(1);
const createHandleClose = (index: number) => () => {
if (typeof index === 'number') {
setSelectedIndex(index);
}
};
return (
<Dropdown>
<MenuButton startDecorator={<Apps />}>Apps</MenuButton>
<Menu>
<MenuItem
{...(selectedIndex === 0 && { selected: true, variant: 'soft' })}
onClick={createHandleClose(0)}
>
Random project
</MenuItem>
<MenuItem selected={selectedIndex === 1} onClick={createHandleClose(1)}>
Production - web
</MenuItem>
<MenuItem selected={selectedIndex === 2} onClick={createHandleClose(2)}>
Staging - web
</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,330 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/SizeMenu.js | import * as React from 'react';
import MenuButton from '@mui/joy/MenuButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import Dropdown from '@mui/joy/Dropdown';
import ListDivider from '@mui/joy/ListDivider';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import Check from '@mui/icons-material/Check';
export default function SizeMenu() {
return (
<Dropdown>
<MenuButton size="sm">Format</MenuButton>
<Menu size="sm">
<MenuItem>
<ListItemDecorator /> Single
</MenuItem>
<MenuItem>
<ListItemDecorator />
1.15
</MenuItem>
<MenuItem>
<ListItemDecorator />
Double
</MenuItem>
<MenuItem>
<ListItemDecorator>
<Check />
</ListItemDecorator>
Custom: 1.2
</MenuItem>
<ListDivider />
<MenuItem>Add space before paragraph</MenuItem>
<MenuItem>Add space after paragraph</MenuItem>
<ListDivider />
<MenuItem>Custom spacing...</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,331 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/SizeMenu.tsx | import * as React from 'react';
import MenuButton from '@mui/joy/MenuButton';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import Dropdown from '@mui/joy/Dropdown';
import ListDivider from '@mui/joy/ListDivider';
import ListItemDecorator from '@mui/joy/ListItemDecorator';
import Check from '@mui/icons-material/Check';
export default function SizeMenu() {
return (
<Dropdown>
<MenuButton size="sm">Format</MenuButton>
<Menu size="sm">
<MenuItem>
<ListItemDecorator /> Single
</MenuItem>
<MenuItem>
<ListItemDecorator />
1.15
</MenuItem>
<MenuItem>
<ListItemDecorator />
Double
</MenuItem>
<MenuItem>
<ListItemDecorator>
<Check />
</ListItemDecorator>
Custom: 1.2
</MenuItem>
<ListDivider />
<MenuItem>Add space before paragraph</MenuItem>
<MenuItem>Add space after paragraph</MenuItem>
<ListDivider />
<MenuItem>Custom spacing...</MenuItem>
</Menu>
</Dropdown>
);
}
| 1,332 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/menu/menu.md | ---
productId: joy-ui
title: React Menu component
components: Menu, MenuItem, MenuList, MenuButton
githubLabel: 'component: menu'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/
unstyled: /base-ui/react-menu/
---
# Menu
<p class="description">Menus display a list of choices on temporary surfaces.</p>
## Introduction
Joy UI provides five menu-related components:
- `MenuButton`: A button that opens a menu. It reuses the styles from [`Button`](/joy-ui/react-button/).
- `Menu`: A listbox popup for wrapping the menu items which reuses the styles from [`List`](/joy-ui/react-list/).
- `MenuItem`: A menu item which reuses the styles from [`ListItemButton`](/joy-ui/react-list/).
- `MenuList`: A standalone listbox for composition usage. It also reuses the styles from [`List`](/joy-ui/react-list/).
- `Dropdown`: The outermost component that wires a button with a menu. It only provides a context and does not render anything.
{{"demo": "MenuUsage.js", "hideToolbar": true, "bg": "gradient"}}
## Component
After [installation](/joy-ui/getting-started/installation/), you can start building with this component using the following basic elements:
```jsx
import Menu from '@mui/joy/Menu';
import MenuButton from '@mui/joy/MenuButton';
import MenuItem from '@mui/joy/MenuItem';
import Dropdown from '@mui/joy/Dropdown';
export default function MyApp() {
return (
<Dropdown>
<MenuButton>Actions</MenuButton>
<Menu>
<MenuItem>Add item</MenuItem>
</Menu>
</Dropdown>
);
}
```
### Basic usage
Place both the Menu and Menu Button inside a Dropdown component.
This will wire them together.
The Menu Button will toggle the visibility of the menu and act as an anchor for the Menu's popup.
The basic version of the menu opens over the anchor element by default.
You can change this via [specific positioning props](#menu-positioning).
When close to the screen's edge, the menu vertically realigns to make sure that all menu items are completely visible.
Choosing an option should immediately, and ideally, commit the option and close the menu.
{{"demo": "BasicMenu.js"}}
### Sizes
The menu component comes with three sizes out of the box: `sm`, `md` (the default), and `lg`.
When specifying a size for the `Menu` component, menu items inside of it will inherit the value.
{{"demo": "SizeMenu.js"}}
:::info
To learn how to add more sizes to the component, check out [Themed components—Extend sizes](/joy-ui/customization/themed-components/#extend-sizes).
:::
### Selected
Use the `selected` prop to signal whether a `MenuItem` is selected or not.
The menu item uses the same styles as the [`ListItemButton`](/joy-ui/react-list/#interactive-list-items).
{{"demo": "SelectedMenu.js"}}
### Icon button menu
To use [IconButton](/joy-ui/react-button/#icon-button) component as a menu button, pass it to the root slot of the `MenuButton` component.
Use `slotProps` to pass props to the IconButton component.
{{"demo": "IconButtonMenu.js"}}
### Positioned menu
The `Menu` is based on the Base UI `Popper` component, which exposes a few [placement props](/base-ui/react-popper/#placement).
For example, this is how you'd go for displaying the menu on the bottom-end of the anchor button.
{{"demo": "PositionedMenu.js"}}
### Group menus
{{"demo": "GroupMenu.js"}}
### Controlling the open state
By default, the open/close state of the menu is managed internally by the Dropdown component.
To control it programmatically from the outside, apply the Dropdown's `open` and `onOpenChange` props as shown below:
{{"demo": "ControlledDropdown.js"}}
### `MenuList` composition
To get full control of the DOM structure, use the `MenuList` component.
You can use it to compose any popup-alike component.
The primary responsibility of this component is handling the focus state.
{{"demo": "MenuListComposition.js"}}
Or display the menu without a popup:
{{"demo": "MenuListGroup.js"}}
## Debugging
To keep the list box open for inspecting elements, enable the `Emulate a focused page` option from the [Chrome DevTool Rendering](https://developer.chrome.com/docs/devtools/rendering/apply-effects/#emulate-a-focused-page) tab.
You can also access this option by using [command menu and search for it](https://developer.chrome.com/docs/devtools/command-menu/).
## Common examples
### Apps menu
This example replicates a menu that contain links to other applications.
{{"demo": "AppsMenu.js"}}
### Menu bar
This example replicates the application menu bar on macOS.
It supports mouse and keyboard navigation between menu items.
{{"demo": "MenuToolbarExample.js"}}
### Side navigation icons
This example is quite common in dashboard applications where the side navigation is shrunk into icons, and the menu is triggered by hovering them.
{{"demo": "MenuIconSideNavExample.js"}}
| 1,333 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/AlertDialogModal.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Divider from '@mui/joy/Divider';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
import DialogActions from '@mui/joy/DialogActions';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DeleteForever from '@mui/icons-material/DeleteForever';
import WarningRoundedIcon from '@mui/icons-material/WarningRounded';
export default function AlertDialogModal() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button
variant="outlined"
color="danger"
endDecorator={<DeleteForever />}
onClick={() => setOpen(true)}
>
Discard
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog variant="outlined" role="alertdialog">
<DialogTitle>
<WarningRoundedIcon />
Confirmation
</DialogTitle>
<Divider />
<DialogContent>
Are you sure you want to discard all of your notes?
</DialogContent>
<DialogActions>
<Button variant="solid" color="danger" onClick={() => setOpen(false)}>
Discard notes
</Button>
<Button variant="plain" color="neutral" onClick={() => setOpen(false)}>
Cancel
</Button>
</DialogActions>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,334 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/AlertDialogModal.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Divider from '@mui/joy/Divider';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
import DialogActions from '@mui/joy/DialogActions';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DeleteForever from '@mui/icons-material/DeleteForever';
import WarningRoundedIcon from '@mui/icons-material/WarningRounded';
export default function AlertDialogModal() {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button
variant="outlined"
color="danger"
endDecorator={<DeleteForever />}
onClick={() => setOpen(true)}
>
Discard
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog variant="outlined" role="alertdialog">
<DialogTitle>
<WarningRoundedIcon />
Confirmation
</DialogTitle>
<Divider />
<DialogContent>
Are you sure you want to discard all of your notes?
</DialogContent>
<DialogActions>
<Button variant="solid" color="danger" onClick={() => setOpen(false)}>
Discard notes
</Button>
<Button variant="plain" color="neutral" onClick={() => setOpen(false)}>
Cancel
</Button>
</DialogActions>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,335 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/BasicModal.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import Typography from '@mui/joy/Typography';
import Sheet from '@mui/joy/Sheet';
export default function BasicModal() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal
aria-labelledby="modal-title"
aria-describedby="modal-desc"
open={open}
onClose={() => setOpen(false)}
sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center' }}
>
<Sheet
variant="outlined"
sx={{
maxWidth: 500,
borderRadius: 'md',
p: 3,
boxShadow: 'lg',
}}
>
<ModalClose variant="plain" sx={{ m: 1 }} />
<Typography
component="h2"
id="modal-title"
level="h4"
textColor="inherit"
fontWeight="lg"
mb={1}
>
This is the modal title
</Typography>
<Typography id="modal-desc" textColor="text.tertiary">
Make sure to use <code>aria-labelledby</code> on the modal dialog with an
optional <code>aria-describedby</code> attribute.
</Typography>
</Sheet>
</Modal>
</React.Fragment>
);
}
| 1,336 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/BasicModal.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import Typography from '@mui/joy/Typography';
import Sheet from '@mui/joy/Sheet';
export default function BasicModal() {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal
aria-labelledby="modal-title"
aria-describedby="modal-desc"
open={open}
onClose={() => setOpen(false)}
sx={{ display: 'flex', justifyContent: 'center', alignItems: 'center' }}
>
<Sheet
variant="outlined"
sx={{
maxWidth: 500,
borderRadius: 'md',
p: 3,
boxShadow: 'lg',
}}
>
<ModalClose variant="plain" sx={{ m: 1 }} />
<Typography
component="h2"
id="modal-title"
level="h4"
textColor="inherit"
fontWeight="lg"
mb={1}
>
This is the modal title
</Typography>
<Typography id="modal-desc" textColor="text.tertiary">
Make sure to use <code>aria-labelledby</code> on the modal dialog with an
optional <code>aria-describedby</code> attribute.
</Typography>
</Sheet>
</Modal>
</React.Fragment>
);
}
| 1,337 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/BasicModalDialog.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Input from '@mui/joy/Input';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
import Stack from '@mui/joy/Stack';
import Add from '@mui/icons-material/Add';
export default function BasicModalDialog() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button
variant="outlined"
color="neutral"
startDecorator={<Add />}
onClick={() => setOpen(true)}
>
New project
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog>
<DialogTitle>Create new project</DialogTitle>
<DialogContent>Fill in the information of the project.</DialogContent>
<form
onSubmit={(event) => {
event.preventDefault();
setOpen(false);
}}
>
<Stack spacing={2}>
<FormControl>
<FormLabel>Name</FormLabel>
<Input autoFocus required />
</FormControl>
<FormControl>
<FormLabel>Description</FormLabel>
<Input required />
</FormControl>
<Button type="submit">Submit</Button>
</Stack>
</form>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,338 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/BasicModalDialog.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Input from '@mui/joy/Input';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
import Stack from '@mui/joy/Stack';
import Add from '@mui/icons-material/Add';
export default function BasicModalDialog() {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button
variant="outlined"
color="neutral"
startDecorator={<Add />}
onClick={() => setOpen(true)}
>
New project
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog>
<DialogTitle>Create new project</DialogTitle>
<DialogContent>Fill in the information of the project.</DialogContent>
<form
onSubmit={(event: React.FormEvent<HTMLFormElement>) => {
event.preventDefault();
setOpen(false);
}}
>
<Stack spacing={2}>
<FormControl>
<FormLabel>Name</FormLabel>
<Input autoFocus required />
</FormControl>
<FormControl>
<FormLabel>Description</FormLabel>
<Input required />
</FormControl>
<Button type="submit">Submit</Button>
</Stack>
</form>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,339 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/CloseModal.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import Typography from '@mui/joy/Typography';
import Sheet from '@mui/joy/Sheet';
export default function CloseModal() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal
aria-labelledby="close-modal-title"
open={open}
onClose={(_event, reason) => {
alert(`Reason: ${reason}`);
setOpen(false);
}}
sx={{
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}}
>
<Sheet
variant="outlined"
sx={{
minWidth: 300,
borderRadius: 'md',
p: 3,
}}
>
<ModalClose variant="outlined" />
<Typography
component="h2"
id="close-modal-title"
level="h4"
textColor="inherit"
fontWeight="lg"
>
Modal title
</Typography>
</Sheet>
</Modal>
</React.Fragment>
);
}
| 1,340 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/CloseModal.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import Typography from '@mui/joy/Typography';
import Sheet from '@mui/joy/Sheet';
export default function CloseModal() {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal
aria-labelledby="close-modal-title"
open={open}
onClose={(_event: React.MouseEvent<HTMLButtonElement>, reason: string) => {
alert(`Reason: ${reason}`);
setOpen(false);
}}
sx={{
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}}
>
<Sheet
variant="outlined"
sx={{
minWidth: 300,
borderRadius: 'md',
p: 3,
}}
>
<ModalClose variant="outlined" />
<Typography
component="h2"
id="close-modal-title"
level="h4"
textColor="inherit"
fontWeight="lg"
>
Modal title
</Typography>
</Sheet>
</Modal>
</React.Fragment>
);
}
| 1,341 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/DialogVerticalScroll.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Switch from '@mui/joy/Switch';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import ModalClose from '@mui/joy/ModalClose';
import DialogTitle from '@mui/joy/DialogTitle';
import Stack from '@mui/joy/Stack';
export default function DialogVerticalScroll() {
const [layout, setLayout] = React.useState(undefined);
const [scroll, setScroll] = React.useState(true);
return (
<React.Fragment>
<Stack direction="row" spacing={1}>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('center');
}}
>
Center
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('fullscreen');
}}
>
Full screen
</Button>
</Stack>
<Modal
open={!!layout}
onClose={() => {
setLayout(undefined);
}}
>
<ModalDialog layout={layout}>
<ModalClose />
<DialogTitle>Vertical scroll example</DialogTitle>
<FormControl
orientation="horizontal"
sx={{ bgcolor: 'background.level2', p: 1, borderRadius: 'sm' }}
>
<FormLabel>Container overflow</FormLabel>
<Switch
checked={scroll}
onChange={(event) => setScroll(event.target.checked)}
sx={{ ml: 'auto' }}
/>
</FormControl>
<List
sx={{
overflow: scroll ? 'scroll' : 'initial',
mx: 'calc(-1 * var(--ModalDialog-padding))',
px: 'var(--ModalDialog-padding)',
}}
>
{[...Array(100)].map((item, index) => (
<ListItem key={index}>I'm in a scrollable area.</ListItem>
))}
</List>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,342 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/DialogVerticalScroll.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Switch from '@mui/joy/Switch';
import Modal from '@mui/joy/Modal';
import ModalDialog, { ModalDialogProps } from '@mui/joy/ModalDialog';
import ModalClose from '@mui/joy/ModalClose';
import DialogTitle from '@mui/joy/DialogTitle';
import Stack from '@mui/joy/Stack';
export default function DialogVerticalScroll() {
const [layout, setLayout] = React.useState<ModalDialogProps['layout'] | undefined>(
undefined,
);
const [scroll, setScroll] = React.useState<boolean>(true);
return (
<React.Fragment>
<Stack direction="row" spacing={1}>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('center');
}}
>
Center
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('fullscreen');
}}
>
Full screen
</Button>
</Stack>
<Modal
open={!!layout}
onClose={() => {
setLayout(undefined);
}}
>
<ModalDialog layout={layout}>
<ModalClose />
<DialogTitle>Vertical scroll example</DialogTitle>
<FormControl
orientation="horizontal"
sx={{ bgcolor: 'background.level2', p: 1, borderRadius: 'sm' }}
>
<FormLabel>Container overflow</FormLabel>
<Switch
checked={scroll}
onChange={(event: React.ChangeEvent<HTMLInputElement>) =>
setScroll(event.target.checked)
}
sx={{ ml: 'auto' }}
/>
</FormControl>
<List
sx={{
overflow: scroll ? 'scroll' : 'initial',
mx: 'calc(-1 * var(--ModalDialog-padding))',
px: 'var(--ModalDialog-padding)',
}}
>
{[...Array(100)].map((item, index) => (
<ListItem key={index}>I'm in a scrollable area.</ListItem>
))}
</List>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,343 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/FadeModalDialog.js | import * as React from 'react';
import { Transition } from 'react-transition-group';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function FadeModalDialog() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Transition in={open} timeout={400}>
{(state) => (
<Modal
keepMounted
open={!['exited', 'exiting'].includes(state)}
onClose={() => setOpen(false)}
slotProps={{
backdrop: {
sx: {
opacity: 0,
backdropFilter: 'none',
transition: `opacity 400ms, backdrop-filter 400ms`,
...{
entering: { opacity: 1, backdropFilter: 'blur(8px)' },
entered: { opacity: 1, backdropFilter: 'blur(8px)' },
}[state],
},
},
}}
sx={{
visibility: state === 'exited' ? 'hidden' : 'visible',
}}
>
<ModalDialog
sx={{
opacity: 0,
transition: `opacity 300ms`,
...{
entering: { opacity: 1 },
entered: { opacity: 1 },
}[state],
}}
>
<DialogTitle>Transition modal</DialogTitle>
<DialogContent>
Using `react-transition-group` to create a fade animation.
</DialogContent>
</ModalDialog>
</Modal>
)}
</Transition>
</React.Fragment>
);
}
| 1,344 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/FadeModalDialog.tsx | import * as React from 'react';
import { Transition } from 'react-transition-group';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function FadeModalDialog() {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Transition in={open} timeout={400}>
{(state: string) => (
<Modal
keepMounted
open={!['exited', 'exiting'].includes(state)}
onClose={() => setOpen(false)}
slotProps={{
backdrop: {
sx: {
opacity: 0,
backdropFilter: 'none',
transition: `opacity 400ms, backdrop-filter 400ms`,
...{
entering: { opacity: 1, backdropFilter: 'blur(8px)' },
entered: { opacity: 1, backdropFilter: 'blur(8px)' },
}[state],
},
},
}}
sx={{
visibility: state === 'exited' ? 'hidden' : 'visible',
}}
>
<ModalDialog
sx={{
opacity: 0,
transition: `opacity 300ms`,
...{
entering: { opacity: 1 },
entered: { opacity: 1 },
}[state],
}}
>
<DialogTitle>Transition modal</DialogTitle>
<DialogContent>
Using `react-transition-group` to create a fade animation.
</DialogContent>
</ModalDialog>
</Modal>
)}
</Transition>
</React.Fragment>
);
}
| 1,345 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/KeepMountedModal.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function KeepMountedModal() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal keepMounted open={open} onClose={() => setOpen(false)}>
<ModalDialog>
<DialogTitle>Keep mounted modal</DialogTitle>
<DialogContent>
This modal is still in the DOM event though it is closed.
</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,346 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/KeepMountedModal.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function KeepMountedModal() {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal keepMounted open={open} onClose={() => setOpen(false)}>
<ModalDialog>
<DialogTitle>Keep mounted modal</DialogTitle>
<DialogContent>
This modal is still in the DOM event though it is closed.
</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,347 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/KeepMountedModal.tsx.preview | <React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal keepMounted open={open} onClose={() => setOpen(false)}>
<ModalDialog>
<DialogTitle>Keep mounted modal</DialogTitle>
<DialogContent>
This modal is still in the DOM event though it is closed.
</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment> | 1,348 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/LayoutModalDialog.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Stack from '@mui/joy/Stack';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function LayoutModalDialog() {
const [layout, setLayout] = React.useState(undefined);
return (
<React.Fragment>
<Stack direction="row" spacing={1}>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('center');
}}
>
Center
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('fullscreen');
}}
>
Full screen
</Button>
</Stack>
<Modal open={!!layout} onClose={() => setLayout(undefined)}>
<ModalDialog layout={layout}>
<ModalClose />
<DialogTitle>Modal Dialog</DialogTitle>
<DialogContent>
<div>
This is a <code>{layout}</code> modal dialog. Press <code>esc</code> to
close it.
</div>
</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,349 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/LayoutModalDialog.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Stack from '@mui/joy/Stack';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog, { ModalDialogProps } from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function LayoutModalDialog() {
const [layout, setLayout] = React.useState<ModalDialogProps['layout'] | undefined>(
undefined,
);
return (
<React.Fragment>
<Stack direction="row" spacing={1}>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('center');
}}
>
Center
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('fullscreen');
}}
>
Full screen
</Button>
</Stack>
<Modal open={!!layout} onClose={() => setLayout(undefined)}>
<ModalDialog layout={layout}>
<ModalClose />
<DialogTitle>Modal Dialog</DialogTitle>
<DialogContent>
<div>
This is a <code>{layout}</code> modal dialog. Press <code>esc</code> to
close it.
</div>
</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,350 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ModalDialogOverflow.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Switch from '@mui/joy/Switch';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog from '@mui/joy/ModalDialog';
import ModalOverflow from '@mui/joy/ModalOverflow';
import Stack from '@mui/joy/Stack';
import Typography from '@mui/joy/Typography';
export default function ModalDialogOverflow() {
const [layout, setLayout] = React.useState(undefined);
const [scroll, setScroll] = React.useState(true);
return (
<React.Fragment>
<Stack direction="row" spacing={1}>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('center');
}}
>
Center
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('fullscreen');
}}
>
Full screen
</Button>
</Stack>
<Modal
open={!!layout}
onClose={() => {
setLayout(undefined);
}}
>
<ModalOverflow>
<ModalDialog aria-labelledby="modal-dialog-overflow" layout={layout}>
<ModalClose />
<Typography id="modal-dialog-overflow" level="h2">
Overflow content
</Typography>
<FormControl
orientation="horizontal"
sx={{ bgcolor: 'background.level2', p: 1, borderRadius: 'sm' }}
>
<FormLabel>Long content</FormLabel>
<Switch
checked={scroll}
onChange={(event) => setScroll(event.target.checked)}
sx={{ ml: 'auto' }}
/>
</FormControl>
{scroll && (
<List>
{[...Array(100)].map((item, index) => (
<ListItem key={index}>Item number ({index})</ListItem>
))}
</List>
)}
</ModalDialog>
</ModalOverflow>
</Modal>
</React.Fragment>
);
}
| 1,351 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ModalDialogOverflow.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Switch from '@mui/joy/Switch';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog, { ModalDialogProps } from '@mui/joy/ModalDialog';
import ModalOverflow from '@mui/joy/ModalOverflow';
import Stack from '@mui/joy/Stack';
import Typography from '@mui/joy/Typography';
export default function ModalDialogOverflow() {
const [layout, setLayout] = React.useState<ModalDialogProps['layout'] | undefined>(
undefined,
);
const [scroll, setScroll] = React.useState<boolean>(true);
return (
<React.Fragment>
<Stack direction="row" spacing={1}>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('center');
}}
>
Center
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setLayout('fullscreen');
}}
>
Full screen
</Button>
</Stack>
<Modal
open={!!layout}
onClose={() => {
setLayout(undefined);
}}
>
<ModalOverflow>
<ModalDialog aria-labelledby="modal-dialog-overflow" layout={layout}>
<ModalClose />
<Typography id="modal-dialog-overflow" level="h2">
Overflow content
</Typography>
<FormControl
orientation="horizontal"
sx={{ bgcolor: 'background.level2', p: 1, borderRadius: 'sm' }}
>
<FormLabel>Long content</FormLabel>
<Switch
checked={scroll}
onChange={(event: React.ChangeEvent<HTMLInputElement>) =>
setScroll(event.target.checked)
}
sx={{ ml: 'auto' }}
/>
</FormControl>
{scroll && (
<List>
{[...Array(100)].map((item, index) => (
<ListItem key={index}>Item number ({index})</ListItem>
))}
</List>
)}
</ModalDialog>
</ModalOverflow>
</Modal>
</React.Fragment>
);
}
| 1,352 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ModalUsage.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
import JoyUsageDemo, {
prependLinesSpace,
} from 'docs/src/modules/components/JoyUsageDemo';
export default function ModalUsage() {
const [open, setOpen] = React.useState(false);
return (
<JoyUsageDemo
componentName="ModalDialog"
data={[
{
propName: 'variant',
knob: 'radio',
defaultValue: 'outlined',
options: ['plain', 'outlined', 'soft', 'solid'],
},
{
propName: 'color',
knob: 'color',
defaultValue: 'neutral',
},
{
propName: 'size',
knob: 'radio',
options: ['sm', 'md', 'lg'],
defaultValue: 'md',
},
{
propName: 'layout',
knob: 'radio',
options: ['center', 'fullscreen'],
defaultValue: 'center',
},
{
propName: 'children',
defaultValue: '<ModalClose />\n <Typography>Modal title</Typography>',
},
]}
getCodeBlock={(code) => `<Modal>
${prependLinesSpace(code, 2)}
</Modal>`}
renderDemo={(props) => (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog {...props}>
<ModalClose />
<DialogTitle>Modal title</DialogTitle>
<DialogContent>
A description of the dialog should give primary message or purpose of
the dialog.
</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
)}
/>
);
}
| 1,353 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/NestedModals.js | import * as React from 'react';
import PropTypes from 'prop-types';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
function randomBetween(min, max) {
return Math.floor(Math.random() * (max - min + 1)) + min;
}
function NestedModals({ random }) {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog
layout="center"
{...(random && {
sx: {
top: `${randomBetween(25, 75)}%`,
left: `${randomBetween(25, 75)}%`,
},
})}
>
<DialogTitle>Infinite modals</DialogTitle>
<DialogContent>Welcome to the infinite nested modals.</DialogContent>
<NestedModals random />
</ModalDialog>
</Modal>
</React.Fragment>
);
}
NestedModals.propTypes = {
random: PropTypes.bool,
};
export default NestedModals;
| 1,354 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/NestedModals.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
type NestedModalsProps = {
random?: boolean;
};
function randomBetween(min: number, max: number) {
return Math.floor(Math.random() * (max - min + 1)) + min;
}
function NestedModals({ random }: NestedModalsProps) {
const [open, setOpen] = React.useState<boolean>(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog
layout="center"
{...(random && {
sx: {
top: `${randomBetween(25, 75)}%`,
left: `${randomBetween(25, 75)}%`,
},
})}
>
<DialogTitle>Infinite modals</DialogTitle>
<DialogContent>Welcome to the infinite nested modals.</DialogContent>
<NestedModals random />
</ModalDialog>
</Modal>
</React.Fragment>
);
}
export default NestedModals;
| 1,355 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ResponsiveModal.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import Typography from '@mui/joy/Typography';
export default function ResponsiveModal() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog
aria-labelledby="nested-modal-title"
aria-describedby="nested-modal-description"
sx={(theme) => ({
[theme.breakpoints.only('xs')]: {
top: 'unset',
bottom: 0,
left: 0,
right: 0,
borderRadius: 0,
transform: 'none',
maxWidth: 'unset',
},
})}
>
<Typography id="nested-modal-title" level="h2">
Are you absolutely sure?
</Typography>
<Typography id="nested-modal-description" textColor="text.tertiary">
This action cannot be undone. This will permanently delete your account
and remove your data from our servers.
</Typography>
<Box
sx={{
mt: 1,
display: 'flex',
gap: 1,
flexDirection: { xs: 'column', sm: 'row-reverse' },
}}
>
<Button variant="solid" color="primary" onClick={() => setOpen(false)}>
Continue
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => setOpen(false)}
>
Cancel
</Button>
</Box>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,356 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ResponsiveModal.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Button from '@mui/joy/Button';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import Typography from '@mui/joy/Typography';
export default function ResponsiveModal() {
const [open, setOpen] = React.useState(false);
return (
<React.Fragment>
<Button variant="outlined" color="neutral" onClick={() => setOpen(true)}>
Open modal
</Button>
<Modal open={open} onClose={() => setOpen(false)}>
<ModalDialog
aria-labelledby="nested-modal-title"
aria-describedby="nested-modal-description"
sx={(theme) => ({
[theme.breakpoints.only('xs')]: {
top: 'unset',
bottom: 0,
left: 0,
right: 0,
borderRadius: 0,
transform: 'none',
maxWidth: 'unset',
},
})}
>
<Typography id="nested-modal-title" level="h2">
Are you absolutely sure?
</Typography>
<Typography id="nested-modal-description" textColor="text.tertiary">
This action cannot be undone. This will permanently delete your account
and remove your data from our servers.
</Typography>
<Box
sx={{
mt: 1,
display: 'flex',
gap: 1,
flexDirection: { xs: 'column', sm: 'row-reverse' },
}}
>
<Button variant="solid" color="primary" onClick={() => setOpen(false)}>
Continue
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => setOpen(false)}
>
Cancel
</Button>
</Box>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,357 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ServerModal.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import Typography from '@mui/joy/Typography';
export default function ServerModal() {
const rootRef = React.useRef(null);
return (
<Box
sx={{
height: 240,
flexGrow: 1,
minWidth: 300,
transform: 'translateZ(0)',
// The position fixed scoping doesn't work in IE11.
// Disable this demo to preserve the others.
'@media all and (-ms-high-contrast: none)': {
display: 'none',
},
}}
ref={rootRef}
>
<Modal
disablePortal
disableEnforceFocus
disableAutoFocus
open
container={() => rootRef.current}
>
<ModalDialog
aria-labelledby="server-modal-title"
aria-describedby="server-modal-description"
layout="center"
>
<Typography id="server-modal-title" level="h2">
Server-side modal
</Typography>
<Typography id="server-modal-description" textColor="text.tertiary">
If you disable JavaScript, you will still see me.
</Typography>
</ModalDialog>
</Modal>
</Box>
);
}
| 1,358 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/ServerModal.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Modal from '@mui/joy/Modal';
import ModalDialog from '@mui/joy/ModalDialog';
import Typography from '@mui/joy/Typography';
export default function ServerModal() {
const rootRef = React.useRef(null);
return (
<Box
sx={{
height: 240,
flexGrow: 1,
minWidth: 300,
transform: 'translateZ(0)',
// The position fixed scoping doesn't work in IE11.
// Disable this demo to preserve the others.
'@media all and (-ms-high-contrast: none)': {
display: 'none',
},
}}
ref={rootRef}
>
<Modal
disablePortal
disableEnforceFocus
disableAutoFocus
open
container={() => rootRef.current}
>
<ModalDialog
aria-labelledby="server-modal-title"
aria-describedby="server-modal-description"
layout="center"
>
<Typography id="server-modal-title" level="h2">
Server-side modal
</Typography>
<Typography id="server-modal-description" textColor="text.tertiary">
If you disable JavaScript, you will still see me.
</Typography>
</ModalDialog>
</Modal>
</Box>
);
}
| 1,359 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/SizeModalDialog.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Stack from '@mui/joy/Stack';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function SizeModalDialog() {
const [size, setSize] = React.useState(undefined);
return (
<React.Fragment>
<Stack direction="row" alignItems="center" spacing={1}>
<Button
variant="outlined"
color="neutral"
size="sm"
onClick={() => setSize('sm')}
>
Small
</Button>
<Button
variant="outlined"
color="neutral"
size="md"
onClick={() => setSize('md')}
>
Medium
</Button>
<Button
variant="outlined"
color="neutral"
size="lg"
onClick={() => setSize('lg')}
>
Large
</Button>
</Stack>
<Modal open={!!size} onClose={() => setSize(undefined)}>
<ModalDialog size={size}>
<ModalClose />
<DialogTitle>Modal Dialog</DialogTitle>
<DialogContent>This is a `{size}` modal dialog.</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,360 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/SizeModalDialog.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Stack from '@mui/joy/Stack';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog, { ModalDialogProps } from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function SizeModalDialog() {
const [size, setSize] = React.useState<ModalDialogProps['size'] | undefined>(
undefined,
);
return (
<React.Fragment>
<Stack direction="row" alignItems="center" spacing={1}>
<Button
variant="outlined"
color="neutral"
size="sm"
onClick={() => setSize('sm')}
>
Small
</Button>
<Button
variant="outlined"
color="neutral"
size="md"
onClick={() => setSize('md')}
>
Medium
</Button>
<Button
variant="outlined"
color="neutral"
size="lg"
onClick={() => setSize('lg')}
>
Large
</Button>
</Stack>
<Modal open={!!size} onClose={() => setSize(undefined)}>
<ModalDialog size={size}>
<ModalClose />
<DialogTitle>Modal Dialog</DialogTitle>
<DialogContent>This is a `{size}` modal dialog.</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,361 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/VariantModalDialog.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import Stack from '@mui/joy/Stack';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function VariantModalDialog() {
const [variant, setVariant] = React.useState(undefined);
return (
<React.Fragment>
<Stack direction="row" alignItems="center" spacing={1}>
<Button
variant="plain"
color="neutral"
onClick={() => {
setVariant('plain');
}}
>
Plain
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setVariant('outlined');
}}
>
Outlined
</Button>
<Button
variant="soft"
color="neutral"
onClick={() => {
setVariant('soft');
}}
>
Soft
</Button>
<Button
variant="solid"
color="neutral"
onClick={() => {
setVariant('solid');
}}
>
Solid
</Button>
</Stack>
<Modal open={!!variant} onClose={() => setVariant(undefined)}>
<ModalDialog variant={variant}>
<ModalClose />
<DialogTitle>Modal Dialog</DialogTitle>
<DialogContent>This is a `{variant}` modal dialog.</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,362 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/VariantModalDialog.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import Stack from '@mui/joy/Stack';
import Modal from '@mui/joy/Modal';
import ModalClose from '@mui/joy/ModalClose';
import ModalDialog, { ModalDialogProps } from '@mui/joy/ModalDialog';
import DialogTitle from '@mui/joy/DialogTitle';
import DialogContent from '@mui/joy/DialogContent';
export default function VariantModalDialog() {
const [variant, setVariant] = React.useState<
ModalDialogProps['variant'] | undefined
>(undefined);
return (
<React.Fragment>
<Stack direction="row" alignItems="center" spacing={1}>
<Button
variant="plain"
color="neutral"
onClick={() => {
setVariant('plain');
}}
>
Plain
</Button>
<Button
variant="outlined"
color="neutral"
onClick={() => {
setVariant('outlined');
}}
>
Outlined
</Button>
<Button
variant="soft"
color="neutral"
onClick={() => {
setVariant('soft');
}}
>
Soft
</Button>
<Button
variant="solid"
color="neutral"
onClick={() => {
setVariant('solid');
}}
>
Solid
</Button>
</Stack>
<Modal open={!!variant} onClose={() => setVariant(undefined)}>
<ModalDialog variant={variant}>
<ModalClose />
<DialogTitle>Modal Dialog</DialogTitle>
<DialogContent>This is a `{variant}` modal dialog.</DialogContent>
</ModalDialog>
</Modal>
</React.Fragment>
);
}
| 1,363 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/modal/modal.md | ---
productId: joy-ui
title: React Modal component
components: Modal, ModalClose, ModalDialog, ModalOverflow, DialogTitle, DialogContent, DialogActions
githubLabel: 'component: modal'
waiAria: https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/
---
# Modal
<p class="description">The modal component provides a solid foundation for creating dialogs, popovers, lightboxes, or whatever else.</p>
{{"component": "modules/components/ComponentLinkHeader.js"}}
## Introduction
Joy UI provides three modal-related components:
- [`Modal`](#basic-usage): A container that renders its `children` node in front of a backdrop component.
- [`ModalClose`](#dialog): A button for closing the modal.
- [`ModalDialog`](#dialog): A component for rendering a modal dialog.
{{"demo": "ModalUsage.js", "hideToolbar": true, "bg": "gradient"}}
### Features
- 🥞 Manages modal stacking when more than one is needed.
- 🪟 Automatically creates a backdrop element to disable interaction with the rest of the app.
- 🔐 Disables page scrolling while open.
- ⌨️ Manages focus correctly between the modal and its parent app.
- ♿️ Adds the appropriate ARIA roles automatically.
:::info
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.
As such, it should be used sparingly—only when the app _requires_ user input before it can continue.
A dialog, on the other hand, may be _modal_ or _nonmodal (modeless)_.
:::
## Component
After [installation](/joy-ui/getting-started/installation/), you can start building with this component using the following basic elements:
```jsx
import Modal from '@mui/joy/Modal';
export default function MyApp() {
return <Modal>{children}</Modal>;
}
```
### Basic usage
The Modal accepts only a single React element as a child.
That can be either a Joy UI component, e.g. [`Sheet`](/joy-ui/react-sheet/), or any other custom element.
Use the Modal Close component to render a close button that inherits the modal's `onClose` function.
{{"demo": "BasicModal.js"}}
:::info
Modal Close accepts the variant prop because it uses the same styles as the [`IconButton`](/joy-ui/react-button/#icon-button).
:::
### Close reason
The second argument of the `onClose` gives you the information about how the event is triggered.
The possible values are:
- `backdropClick`: the user clicks on the modal's backdrop.
- `escapeKeyDown`: the user presses `Escape` on the keyboard.
- `closeClick`: the user clicks on the `ModalClose` element.
{{"demo": "CloseModal.js"}}
### Modal Dialog
To create a modal dialog, render the Modal Dialog component inside the Modal.
The Dialog will apply spacing to the elements that have `aria-labelledby` or `aria-describedby` attribute.
{{"demo": "BasicModalDialog.js"}}
#### Variant
The Modal Dialog supports the [global variants](/joy-ui/main-features/global-variants/) feature.
The Modal Close component's variant adapts automatically to contrast with the Modal Dialog, as demonstrated below:
{{"demo": "VariantModalDialog.js"}}
#### Size
The Modal Dialog comes in 3 sizes: `sm`, `md` (default), and `lg`.
The Modal Close and Modal Dialog Title components inherit the size from the Modal Dialog unless specified in each component directly.
{{"demo": "SizeModalDialog.js"}}
#### Layout
The Modal Dialog's layout can be:
- `center` (default): the modal dialog appears at the center of the viewport.
- `fullScreen`: the modal dialog covers the whole viewport.
{{"demo": "LayoutModalDialog.js"}}
To add more layout, create a new theme with [`styleOverrides`](/joy-ui/customization/themed-components/#theme-style-overrides) like this:
```js
const theme = extendTheme({
components: {
JoyModalDialog: {
defaultProps: { layout: 'top' },
styleOverrides: {
root: ({ ownerState }) => ({
...(ownerState.layout === 'top' && {
top: '12vh',
left: '50%',
transform: 'translateX(-50%)',
}),
}),
},
},
},
});
```
For **TypeScript**, you need module augmentation to include the new values to the `layout` prop:
```ts
// at the root or theme file
declare module '@mui/joy/ModalDialog' {
interface ModalDialogPropsLayoutOverrides {
top: true;
}
}
```
#### Vertical scroll
By default, content within the Modal Dialog won't overflow the screen when its height is bigger than the viewport.
To ensure your content is visible, make the container holding it overflow by adding the [`overflow` CSS property](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow) with either `scroll` or `auto` values.
{{"demo": "DialogVerticalScroll.js"}}
### Modal Overflow
The previous section demonstrated how to make content _within_ the modal scrollable.
To make the _whole_ modal scrollable, in case its higher than the viewport, use the Modal Overflow component.
It will allow the Modal Dialog to vertically overflow the screen.
The Modal Overflow supports both `center` and `fullScreen` built-in layouts.
{{"demo": "ModalDialogOverflow.js"}}
You can achieve the same result by using the Box component and CSS with the `sx` prop.
However, the Modal Overflow component adds greater convenience:
- It makes your styling more consistent, as you won't need to copy styles across different instances.
- You can also add theming customization to it directly from the theme.
- It automatically handles the close action when the user clicks on the Modal's backdrop.
### Alert dialog
Use `role="alertdialog"` to create an [alert dialog](https://www.w3.org/WAI/ARIA/apg/patterns/alertdialog/) that interrupts the user's workflow.
{{"demo": "AlertDialogModal.js"}}
### Nested modals
The modal components can be nested:
{{"demo": "NestedModals.js"}}
:::warning
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.
:::
### Transition
The modal components **do not** come with built-in transitions.
Here is one example using [`react-transition-group`](https://reactcommunity.org/react-transition-group/transition/) to create a fade animation:
{{"demo": "FadeModalDialog.js"}}
### Performance
The modal's content is unmounted when it is not open.
This means that it will need to be re-mounted each time it is opened.
If you are rendering "expensive" component trees inside your modal, and you want to optimize for interaction responsiveness, change the default behavior by enabling the `keepMounted` prop.
Use the `keepMounted` prop to make the content of the modal available to search engines (even when the modal is closed).
The following demo shows how to apply this prop to keep the modal mounted:
{{"demo": "KeepMountedModal.js", "defaultCodeOpen": false}}
As with any performance optimization, the `keepMounted` prop won't necessarily solve all of your problems.
Explore other possible bottlenecks in performance where you could make more considerable improvements before implementing this prop.
### Server-side modal
React [doesn't support](https://github.com/facebook/react/issues/13097) the [`createPortal()`](https://react.dev/reference/react-dom/createPortal) API on the server.
Therefore, in order to display a modal rendered on the server, disable the portal feature with the `disablePortal` prop, as shown in the following demo:
{{"demo": "ServerModal.js", "defaultCodeOpen": false}}
## Common examples
### Mobile modal
Use `sx` prop with `theme.breakpoints.only('xs')` to customize the styles of the modal dialog to stick at the bottom in mobile viewport.
{{"demo": "ResponsiveModal.js"}}
## Limitations
### Focus trap
Base UI `Modal` moves the focus back to the body of the component if the focus tries to escape it.
This is done for accessibility purposes, but it can potentially create issues for your users.
If the user needs to interact with another part of the page－for example, to interact with a chatbot window while a modal is open in the parent app－you can disable the default behavior with the `disableEnforceFocus` prop.
## Accessibility
See the [WAI-ARIA guide on the Dialog (Modal) pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) for complete details on accessibility best practices. Here are a couple of highlights:
- All interactive elements must have an [accessible name](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby). Use the `aria-labelledby="id..."` to give your `Modal` component an accessible name.
You can also use `aria-describedby="id..."` to provide a description of the `Modal`:
```jsx
<Modal aria-labelledby="modal-title" aria-describedby="modal-description">
<h2 id="modal-title">My Title</h2>
<p id="modal-description">My Description</p>
</Modal>
```
- Follow the [WAI-ARIA authoring practices](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/examples/dialog/) to help you set the initial focus on the most relevant element based on the content of the modal.
:::warning
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).
:::
| 1,364 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ControlledRadioButtonsGroup.js | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function ControlledRadioButtonsGroup() {
const [value, setValue] = React.useState('female');
const handleChange = (event) => {
setValue(event.target.value);
};
return (
<FormControl>
<FormLabel>Gender</FormLabel>
<RadioGroup
defaultValue="female"
name="controlled-radio-buttons-group"
value={value}
onChange={handleChange}
sx={{ my: 1 }}
>
<Radio value="female" label="Female" />
<Radio value="male" label="Male" />
<Radio value="other" label="Other" />
</RadioGroup>
</FormControl>
);
}
| 1,365 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ControlledRadioButtonsGroup.tsx | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function ControlledRadioButtonsGroup() {
const [value, setValue] = React.useState('female');
const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
setValue(event.target.value);
};
return (
<FormControl>
<FormLabel>Gender</FormLabel>
<RadioGroup
defaultValue="female"
name="controlled-radio-buttons-group"
value={value}
onChange={handleChange}
sx={{ my: 1 }}
>
<Radio value="female" label="Female" />
<Radio value="male" label="Male" />
<Radio value="other" label="Other" />
</RadioGroup>
</FormControl>
);
}
| 1,366 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ControlledRadioButtonsGroup.tsx.preview | <FormControl>
<FormLabel>Gender</FormLabel>
<RadioGroup
defaultValue="female"
name="controlled-radio-buttons-group"
value={value}
onChange={handleChange}
sx={{ my: 1 }}
>
<Radio value="female" label="Female" />
<Radio value="male" label="Male" />
<Radio value="other" label="Other" />
</RadioGroup>
</FormControl> | 1,367 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleAlignmentButtons.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import FormatAlignCenterIcon from '@mui/icons-material/FormatAlignCenter';
import FormatAlignJustifyIcon from '@mui/icons-material/FormatAlignJustify';
import FormatAlignLeftIcon from '@mui/icons-material/FormatAlignLeft';
import FormatAlignRightIcon from '@mui/icons-material/FormatAlignRight';
export default function ExampleAlignmentButtons() {
const [alignment, setAlignment] = React.useState('left');
return (
<RadioGroup
orientation="horizontal"
aria-label="Alignment"
name="alignment"
variant="outlined"
value={alignment}
onChange={(event) => setAlignment(event.target.value)}
>
{['left', 'center', 'right', 'justify'].map((item) => (
<Box
key={item}
sx={(theme) => ({
position: 'relative',
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
width: 48,
height: 48,
'&:not([data-first-child])': {
borderLeft: '1px solid',
borderColor: 'divider',
},
[`&[data-first-child] .${radioClasses.action}`]: {
borderTopLeftRadius: `calc(${theme.vars.radius.sm} - 1px)`,
borderBottomLeftRadius: `calc(${theme.vars.radius.sm} - 1px)`,
},
[`&[data-last-child] .${radioClasses.action}`]: {
borderTopRightRadius: `calc(${theme.vars.radius.sm} - 1px)`,
borderBottomRightRadius: `calc(${theme.vars.radius.sm} - 1px)`,
},
})}
>
<Radio
value={item}
disableIcon
overlay
label={
{
left: <FormatAlignLeftIcon />,
right: <FormatAlignRightIcon />,
center: <FormatAlignCenterIcon />,
justify: <FormatAlignJustifyIcon />,
}[item]
}
variant={alignment === item ? 'solid' : 'plain'}
slotProps={{
input: { 'aria-label': item },
action: {
sx: { borderRadius: 0, transition: 'none' },
},
label: { sx: { lineHeight: 0 } },
}}
/>
</Box>
))}
</RadioGroup>
);
}
| 1,368 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleAlignmentButtons.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import FormatAlignCenterIcon from '@mui/icons-material/FormatAlignCenter';
import FormatAlignJustifyIcon from '@mui/icons-material/FormatAlignJustify';
import FormatAlignLeftIcon from '@mui/icons-material/FormatAlignLeft';
import FormatAlignRightIcon from '@mui/icons-material/FormatAlignRight';
export default function ExampleAlignmentButtons() {
const [alignment, setAlignment] = React.useState('left');
return (
<RadioGroup
orientation="horizontal"
aria-label="Alignment"
name="alignment"
variant="outlined"
value={alignment}
onChange={(event: React.ChangeEvent<HTMLInputElement>) =>
setAlignment(event.target.value)
}
>
{['left', 'center', 'right', 'justify'].map((item) => (
<Box
key={item}
sx={(theme) => ({
position: 'relative',
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
width: 48,
height: 48,
'&:not([data-first-child])': {
borderLeft: '1px solid',
borderColor: 'divider',
},
[`&[data-first-child] .${radioClasses.action}`]: {
borderTopLeftRadius: `calc(${theme.vars.radius.sm} - 1px)`,
borderBottomLeftRadius: `calc(${theme.vars.radius.sm} - 1px)`,
},
[`&[data-last-child] .${radioClasses.action}`]: {
borderTopRightRadius: `calc(${theme.vars.radius.sm} - 1px)`,
borderBottomRightRadius: `calc(${theme.vars.radius.sm} - 1px)`,
},
})}
>
<Radio
value={item}
disableIcon
overlay
label={
{
left: <FormatAlignLeftIcon />,
right: <FormatAlignRightIcon />,
center: <FormatAlignCenterIcon />,
justify: <FormatAlignJustifyIcon />,
}[item]
}
variant={alignment === item ? 'solid' : 'plain'}
slotProps={{
input: { 'aria-label': item },
action: {
sx: { borderRadius: 0, transition: 'none' },
},
label: { sx: { lineHeight: 0 } },
}}
/>
</Box>
))}
</RadioGroup>
);
}
| 1,369 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExamplePaymentChannels.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import List from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListDivider from '@mui/joy/ListDivider';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Typography from '@mui/joy/Typography';
import Switch from '@mui/joy/Switch';
export default function ExamplePaymentChannels() {
const [orientation, setOrientation] = React.useState('vertical');
return (
<Box sx={{ minWidth: 240 }}>
<Box
sx={{
mb: 2,
display: 'flex',
justifyContent: 'space-between',
alignItems: 'center',
}}
>
<Typography
id="example-payment-channel-label"
level="title-md"
textColor={'text.secondary'}
fontWeight="xl"
>
Pay with
</Typography>
<Switch
component="label"
size="sm"
startDecorator="List"
endDecorator="Row"
checked={orientation === 'horizontal'}
onChange={(event) =>
setOrientation(event.target.checked ? 'horizontal' : 'vertical')
}
/>
</Box>
<RadioGroup
aria-labelledby="example-payment-channel-label"
overlay
name="example-payment-channel"
defaultValue="Paypal"
>
<List
component="div"
variant="outlined"
orientation={orientation}
sx={{
borderRadius: 'sm',
boxShadow: 'sm',
}}
>
{['Credit Card', 'Paypal', 'QR Code'].map((value, index) => (
<React.Fragment key={value}>
{index !== 0 && <ListDivider />}
<ListItem>
<Radio id={value} value={value} label={value} />
</ListItem>
</React.Fragment>
))}
</List>
</RadioGroup>
</Box>
);
}
| 1,370 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExamplePaymentChannels.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import List, { ListProps } from '@mui/joy/List';
import ListItem from '@mui/joy/ListItem';
import ListDivider from '@mui/joy/ListDivider';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Typography from '@mui/joy/Typography';
import Switch from '@mui/joy/Switch';
export default function ExamplePaymentChannels() {
const [orientation, setOrientation] =
React.useState<ListProps['orientation']>('vertical');
return (
<Box sx={{ minWidth: 240 }}>
<Box
sx={{
mb: 2,
display: 'flex',
justifyContent: 'space-between',
alignItems: 'center',
}}
>
<Typography
id="example-payment-channel-label"
level="title-md"
textColor={'text.secondary'}
fontWeight="xl"
>
Pay with
</Typography>
<Switch
component="label"
size="sm"
startDecorator="List"
endDecorator="Row"
checked={orientation === 'horizontal'}
onChange={(event: React.ChangeEvent<HTMLInputElement>) =>
setOrientation(event.target.checked ? 'horizontal' : 'vertical')
}
/>
</Box>
<RadioGroup
aria-labelledby="example-payment-channel-label"
overlay
name="example-payment-channel"
defaultValue="Paypal"
>
<List
component="div"
variant="outlined"
orientation={orientation}
sx={{
borderRadius: 'sm',
boxShadow: 'sm',
}}
>
{['Credit Card', 'Paypal', 'QR Code'].map((value, index) => (
<React.Fragment key={value}>
{index !== 0 && <ListDivider />}
<ListItem>
<Radio id={value} value={value} label={value} />
</ListItem>
</React.Fragment>
))}
</List>
</RadioGroup>
</Box>
);
}
| 1,371 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleProductAttributes.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import FormLabel from '@mui/joy/FormLabel';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
import Done from '@mui/icons-material/Done';
export default function ExampleProductAttributes() {
return (
<Box sx={{ resize: 'horizontal', overflow: 'auto', px: 2 }}>
<FormLabel
id="product-color-attribute"
sx={{
mb: 1.5,
fontWeight: 'xl',
textTransform: 'uppercase',
fontSize: 'xs',
letterSpacing: '0.1em',
}}
>
Color
</FormLabel>
<RadioGroup
aria-labelledby="product-color-attribute"
defaultValue="warning"
sx={{ gap: 2, flexWrap: 'wrap', flexDirection: 'row' }}
>
{['primary', 'neutral', 'danger', 'success', 'warning'].map((color) => (
<Sheet
key={color}
sx={{
position: 'relative',
width: 40,
height: 40,
flexShrink: 0,
bgcolor: `${color}.solidBg`,
borderRadius: '50%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}}
>
<Radio
overlay
variant="solid"
color={color}
checkedIcon={<Done fontSize="xl2" />}
value={color}
slotProps={{
input: { 'aria-label': color },
radio: {
sx: {
display: 'contents',
'--variant-borderWidth': '2px',
},
},
}}
sx={{
'--joy-focus-outlineOffset': '4px',
'--joy-palette-focusVisible': (theme) =>
theme.vars.palette[color][500],
[`& .${radioClasses.action}.${radioClasses.focusVisible}`]: {
outlineWidth: '2px',
},
}}
/>
</Sheet>
))}
</RadioGroup>
<br />
<FormLabel
id="product-size-attribute"
sx={{
mb: 1.5,
fontWeight: 'xl',
textTransform: 'uppercase',
fontSize: 'xs',
letterSpacing: '0.1em',
}}
>
Size
</FormLabel>
<RadioGroup
aria-labelledby="product-size-attribute"
defaultValue="M"
sx={{ gap: 2, mb: 2, flexWrap: 'wrap', flexDirection: 'row' }}
>
{['XS', 'S', 'M', 'L', 'XL'].map((size) => (
<Sheet
key={size}
sx={{
position: 'relative',
width: 40,
height: 40,
flexShrink: 0,
borderRadius: '50%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
'--joy-focus-outlineOffset': '4px',
'--joy-palette-focusVisible': (theme) =>
theme.vars.palette.neutral.outlinedBorder,
[`& .${radioClasses.checked}`]: {
[`& .${radioClasses.label}`]: {
fontWeight: 'lg',
},
[`& .${radioClasses.action}`]: {
'--variant-borderWidth': '2px',
borderColor: 'text.secondary',
},
},
[`& .${radioClasses.action}.${radioClasses.focusVisible}`]: {
outlineWidth: '2px',
},
}}
>
<Radio color="neutral" overlay disableIcon value={size} label={size} />
</Sheet>
))}
</RadioGroup>
</Box>
);
}
| 1,372 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleProductAttributes.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import FormLabel from '@mui/joy/FormLabel';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
import Done from '@mui/icons-material/Done';
export default function ExampleProductAttributes() {
return (
<Box sx={{ resize: 'horizontal', overflow: 'auto', px: 2 }}>
<FormLabel
id="product-color-attribute"
sx={{
mb: 1.5,
fontWeight: 'xl',
textTransform: 'uppercase',
fontSize: 'xs',
letterSpacing: '0.1em',
}}
>
Color
</FormLabel>
<RadioGroup
aria-labelledby="product-color-attribute"
defaultValue="warning"
sx={{ gap: 2, flexWrap: 'wrap', flexDirection: 'row' }}
>
{(['primary', 'neutral', 'danger', 'success', 'warning'] as const).map(
(color) => (
<Sheet
key={color}
sx={{
position: 'relative',
width: 40,
height: 40,
flexShrink: 0,
bgcolor: `${color}.solidBg`,
borderRadius: '50%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}}
>
<Radio
overlay
variant="solid"
color={color}
checkedIcon={<Done fontSize="xl2" />}
value={color}
slotProps={{
input: { 'aria-label': color },
radio: {
sx: {
display: 'contents',
'--variant-borderWidth': '2px',
},
},
}}
sx={{
'--joy-focus-outlineOffset': '4px',
'--joy-palette-focusVisible': (theme) =>
theme.vars.palette[color][500],
[`& .${radioClasses.action}.${radioClasses.focusVisible}`]: {
outlineWidth: '2px',
},
}}
/>
</Sheet>
),
)}
</RadioGroup>
<br />
<FormLabel
id="product-size-attribute"
sx={{
mb: 1.5,
fontWeight: 'xl',
textTransform: 'uppercase',
fontSize: 'xs',
letterSpacing: '0.1em',
}}
>
Size
</FormLabel>
<RadioGroup
aria-labelledby="product-size-attribute"
defaultValue="M"
sx={{ gap: 2, mb: 2, flexWrap: 'wrap', flexDirection: 'row' }}
>
{['XS', 'S', 'M', 'L', 'XL'].map((size) => (
<Sheet
key={size}
sx={{
position: 'relative',
width: 40,
height: 40,
flexShrink: 0,
borderRadius: '50%',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
'--joy-focus-outlineOffset': '4px',
'--joy-palette-focusVisible': (theme) =>
theme.vars.palette.neutral.outlinedBorder,
[`& .${radioClasses.checked}`]: {
[`& .${radioClasses.label}`]: {
fontWeight: 'lg',
},
[`& .${radioClasses.action}`]: {
'--variant-borderWidth': '2px',
borderColor: 'text.secondary',
},
},
[`& .${radioClasses.action}.${radioClasses.focusVisible}`]: {
outlineWidth: '2px',
},
}}
>
<Radio color="neutral" overlay disableIcon value={size} label={size} />
</Sheet>
))}
</RadioGroup>
</Box>
);
}
| 1,373 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleSegmentedControls.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Typography from '@mui/joy/Typography';
export default function ExampleSegmentedControls() {
const [justify, setJustify] = React.useState('flex-start');
return (
<Box sx={{ display: 'flex', alignItems: 'center', gap: 2 }}>
<Typography id="segmented-controls-example" fontWeight="lg" fontSize="sm">
Justify:
</Typography>
<RadioGroup
orientation="horizontal"
aria-labelledby="segmented-controls-example"
name="justify"
value={justify}
onChange={(event) => setJustify(event.target.value)}
sx={{
minHeight: 48,
padding: '4px',
borderRadius: '12px',
bgcolor: 'neutral.softBg',
'--RadioGroup-gap': '4px',
'--Radio-actionRadius': '8px',
}}
>
{['flex-start', 'center', 'flex-end'].map((item) => (
<Radio
key={item}
color="neutral"
value={item}
disableIcon
label={item}
variant="plain"
sx={{
px: 2,
alignItems: 'center',
}}
slotProps={{
action: ({ checked }) => ({
sx: {
...(checked && {
bgcolor: 'background.surface',
boxShadow: 'sm',
'&:hover': {
bgcolor: 'background.surface',
},
}),
},
}),
}}
/>
))}
</RadioGroup>
</Box>
);
}
| 1,374 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleSegmentedControls.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Typography from '@mui/joy/Typography';
export default function ExampleSegmentedControls() {
const [justify, setJustify] = React.useState('flex-start');
return (
<Box sx={{ display: 'flex', alignItems: 'center', gap: 2 }}>
<Typography id="segmented-controls-example" fontWeight="lg" fontSize="sm">
Justify:
</Typography>
<RadioGroup
orientation="horizontal"
aria-labelledby="segmented-controls-example"
name="justify"
value={justify}
onChange={(event: React.ChangeEvent<HTMLInputElement>) =>
setJustify(event.target.value)
}
sx={{
minHeight: 48,
padding: '4px',
borderRadius: '12px',
bgcolor: 'neutral.softBg',
'--RadioGroup-gap': '4px',
'--Radio-actionRadius': '8px',
}}
>
{['flex-start', 'center', 'flex-end'].map((item) => (
<Radio
key={item}
color="neutral"
value={item}
disableIcon
label={item}
variant="plain"
sx={{
px: 2,
alignItems: 'center',
}}
slotProps={{
action: ({ checked }) => ({
sx: {
...(checked && {
bgcolor: 'background.surface',
boxShadow: 'sm',
'&:hover': {
bgcolor: 'background.surface',
},
}),
},
}),
}}
/>
))}
</RadioGroup>
</Box>
);
}
| 1,375 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleTiers.js | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormHelperText from '@mui/joy/FormHelperText';
import RadioGroup from '@mui/joy/RadioGroup';
import Radio from '@mui/joy/Radio';
import Sheet from '@mui/joy/Sheet';
export default function ExampleTiers() {
return (
<Sheet
variant="outlined"
sx={{
boxShadow: 'sm',
borderRadius: 'sm',
p: 1,
}}
>
<RadioGroup name="tiers" sx={{ gap: 1, '& > div': { p: 1 } }}>
<FormControl size="sm">
<Radio overlay value="small" label="Small" />
<FormHelperText>
For light background jobs like sending email
</FormHelperText>
</FormControl>
<FormControl>
<Radio overlay value="medium" label="Medium" />
<FormHelperText>
For tasks like image resizing, exporting PDFs, etc.
</FormHelperText>
</FormControl>
<FormControl size="lg">
<Radio overlay value="large" label="Large" />
<FormHelperText>
For intensive tasks like video encoding, etc.
</FormHelperText>
</FormControl>
</RadioGroup>
</Sheet>
);
}
| 1,376 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/ExampleTiers.tsx | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormHelperText from '@mui/joy/FormHelperText';
import RadioGroup from '@mui/joy/RadioGroup';
import Radio from '@mui/joy/Radio';
import Sheet from '@mui/joy/Sheet';
export default function ExampleTiers() {
return (
<Sheet
variant="outlined"
sx={{
boxShadow: 'sm',
borderRadius: 'sm',
p: 1,
}}
>
<RadioGroup name="tiers" sx={{ gap: 1, '& > div': { p: 1 } }}>
<FormControl size="sm">
<Radio overlay value="small" label="Small" />
<FormHelperText>
For light background jobs like sending email
</FormHelperText>
</FormControl>
<FormControl>
<Radio overlay value="medium" label="Medium" />
<FormHelperText>
For tasks like image resizing, exporting PDFs, etc.
</FormHelperText>
</FormControl>
<FormControl size="lg">
<Radio overlay value="large" label="Large" />
<FormHelperText>
For intensive tasks like video encoding, etc.
</FormHelperText>
</FormControl>
</RadioGroup>
</Sheet>
);
}
| 1,377 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/IconlessRadio.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
export default function IconlessRadio() {
return (
<Box sx={{ width: 300 }}>
<FormLabel
id="storage-label"
sx={{
mb: 2,
fontWeight: 'xl',
textTransform: 'uppercase',
fontSize: 'xs',
letterSpacing: '0.15rem',
}}
>
Storage
</FormLabel>
<RadioGroup
aria-labelledby="storage-label"
defaultValue="512GB"
size="lg"
sx={{ gap: 1.5 }}
>
{['512GB', '1TB', '2TB'].map((value) => (
<Sheet
key={value}
sx={{
p: 2,
borderRadius: 'md',
boxShadow: 'sm',
}}
>
<Radio
label={`${value} SSD storage`}
overlay
disableIcon
value={value}
slotProps={{
label: ({ checked }) => ({
sx: {
fontWeight: 'lg',
fontSize: 'md',
color: checked ? 'text.primary' : 'text.secondary',
},
}),
action: ({ checked }) => ({
sx: (theme) => ({
...(checked && {
'--variant-borderWidth': '2px',
'&&': {
// && to increase the specificity to win the base :hover styles
borderColor: theme.vars.palette.primary[500],
},
}),
}),
}),
}}
/>
</Sheet>
))}
</RadioGroup>
</Box>
);
}
| 1,378 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/IconlessRadio.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
export default function IconlessRadio() {
return (
<Box sx={{ width: 300 }}>
<FormLabel
id="storage-label"
sx={{
mb: 2,
fontWeight: 'xl',
textTransform: 'uppercase',
fontSize: 'xs',
letterSpacing: '0.15rem',
}}
>
Storage
</FormLabel>
<RadioGroup
aria-labelledby="storage-label"
defaultValue="512GB"
size="lg"
sx={{ gap: 1.5 }}
>
{['512GB', '1TB', '2TB'].map((value) => (
<Sheet
key={value}
sx={{
p: 2,
borderRadius: 'md',
boxShadow: 'sm',
}}
>
<Radio
label={`${value} SSD storage`}
overlay
disableIcon
value={value}
slotProps={{
label: ({ checked }) => ({
sx: {
fontWeight: 'lg',
fontSize: 'md',
color: checked ? 'text.primary' : 'text.secondary',
},
}),
action: ({ checked }) => ({
sx: (theme) => ({
...(checked && {
'--variant-borderWidth': '2px',
'&&': {
// && to increase the specificity to win the base :hover styles
borderColor: theme.vars.palette.primary[500],
},
}),
}),
}),
}}
/>
</Sheet>
))}
</RadioGroup>
</Box>
);
}
| 1,379 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/IconsRadio.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import FormLabel from '@mui/joy/FormLabel';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
import CheckCircleRoundedIcon from '@mui/icons-material/CheckCircleRounded';
export default function IconsRadio() {
return (
<RadioGroup
aria-label="platform"
defaultValue="Website"
overlay
name="platform"
sx={{
flexDirection: 'row',
gap: 2,
[`& .${radioClasses.checked}`]: {
[`& .${radioClasses.action}`]: {
inset: -1,
border: '3px solid',
borderColor: 'primary.500',
},
},
[`& .${radioClasses.radio}`]: {
display: 'contents',
'& > svg': {
zIndex: 2,
position: 'absolute',
top: '-8px',
right: '-8px',
bgcolor: 'background.surface',
borderRadius: '50%',
},
},
}}
>
{['Website', 'Documents', 'Social Account'].map((value) => (
<Sheet
key={value}
variant="outlined"
sx={{
borderRadius: 'md',
boxShadow: 'sm',
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 1.5,
p: 2,
minWidth: 120,
}}
>
<Radio id={value} value={value} checkedIcon={<CheckCircleRoundedIcon />} />
<Avatar variant="soft" size="sm" />
<FormLabel htmlFor={value}>{value}</FormLabel>
</Sheet>
))}
</RadioGroup>
);
}
| 1,380 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/IconsRadio.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import FormLabel from '@mui/joy/FormLabel';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
import CheckCircleRoundedIcon from '@mui/icons-material/CheckCircleRounded';
export default function IconsRadio() {
return (
<RadioGroup
aria-label="platform"
defaultValue="Website"
overlay
name="platform"
sx={{
flexDirection: 'row',
gap: 2,
[`& .${radioClasses.checked}`]: {
[`& .${radioClasses.action}`]: {
inset: -1,
border: '3px solid',
borderColor: 'primary.500',
},
},
[`& .${radioClasses.radio}`]: {
display: 'contents',
'& > svg': {
zIndex: 2,
position: 'absolute',
top: '-8px',
right: '-8px',
bgcolor: 'background.surface',
borderRadius: '50%',
},
},
}}
>
{['Website', 'Documents', 'Social Account'].map((value) => (
<Sheet
key={value}
variant="outlined"
sx={{
borderRadius: 'md',
boxShadow: 'sm',
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 1.5,
p: 2,
minWidth: 120,
}}
>
<Radio id={value} value={value} checkedIcon={<CheckCircleRoundedIcon />} />
<Avatar variant="soft" size="sm" />
<FormLabel htmlFor={value}>{value}</FormLabel>
</Sheet>
))}
</RadioGroup>
);
}
| 1,381 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/OverlayRadio.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
import Typography from '@mui/joy/Typography';
export default function OverlayRadio() {
return (
<FormControl>
<FormLabel>Members</FormLabel>
<RadioGroup
overlay
name="member"
defaultValue="person1"
orientation="horizontal"
sx={{ gap: 2 }}
>
{[1, 2, 3].map((num) => (
<Sheet
component="label"
key={num}
variant="outlined"
sx={{
p: 2,
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
boxShadow: 'sm',
borderRadius: 'md',
}}
>
<Radio
value={`person${num}`}
variant="soft"
sx={{
mb: 2,
}}
/>
<Avatar alt={`person${num}`} src={`/static/images/avatar/${num}.jpg`} />
<Typography level="body-sm" sx={{ mt: 1 }}>
Person {num}
</Typography>
</Sheet>
))}
</RadioGroup>
</FormControl>
);
}
| 1,382 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/OverlayRadio.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
import Sheet from '@mui/joy/Sheet';
import Typography from '@mui/joy/Typography';
export default function OverlayRadio() {
return (
<FormControl>
<FormLabel>Members</FormLabel>
<RadioGroup
overlay
name="member"
defaultValue="person1"
orientation="horizontal"
sx={{ gap: 2 }}
>
{[1, 2, 3].map((num) => (
<Sheet
component="label"
key={num}
variant="outlined"
sx={{
p: 2,
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
boxShadow: 'sm',
borderRadius: 'md',
}}
>
<Radio
value={`person${num}`}
variant="soft"
sx={{
mb: 2,
}}
/>
<Avatar alt={`person${num}`} src={`/static/images/avatar/${num}.jpg`} />
<Typography level="body-sm" sx={{ mt: 1 }}>
Person {num}
</Typography>
</Sheet>
))}
</RadioGroup>
</FormControl>
);
}
| 1,383 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonControl.js | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import FormHelperText from '@mui/joy/FormHelperText';
import Radio from '@mui/joy/Radio';
export default function RadioButtonControl() {
return (
<FormControl sx={{ p: 2, flexDirection: 'row', gap: 2 }}>
<Radio overlay defaultChecked />
<div>
<FormLabel>Selection title</FormLabel>
<FormHelperText>One line description maximum lorem ipsum </FormHelperText>
</div>
</FormControl>
);
}
| 1,384 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonControl.tsx | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import FormHelperText from '@mui/joy/FormHelperText';
import Radio from '@mui/joy/Radio';
export default function RadioButtonControl() {
return (
<FormControl sx={{ p: 2, flexDirection: 'row', gap: 2 }}>
<Radio overlay defaultChecked />
<div>
<FormLabel>Selection title</FormLabel>
<FormHelperText>One line description maximum lorem ipsum </FormHelperText>
</div>
</FormControl>
);
}
| 1,385 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonControl.tsx.preview | <FormControl sx={{ p: 2, flexDirection: 'row', gap: 2 }}>
<Radio overlay defaultChecked />
<div>
<FormLabel>Selection title</FormLabel>
<FormHelperText>One line description maximum lorem ipsum </FormHelperText>
</div>
</FormControl> | 1,386 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonLabel.js | import * as React from 'react';
import Radio from '@mui/joy/Radio';
export default function RadioButtonLabel() {
return <Radio label="Text" defaultChecked />;
}
| 1,387 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonLabel.tsx | import * as React from 'react';
import Radio from '@mui/joy/Radio';
export default function RadioButtonLabel() {
return <Radio label="Text" defaultChecked />;
}
| 1,388 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonLabel.tsx.preview | <Radio label="Text" defaultChecked /> | 1,389 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtons.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Radio from '@mui/joy/Radio';
export default function RadioButtons() {
const [selectedValue, setSelectedValue] = React.useState('a');
const handleChange = (event) => {
setSelectedValue(event.target.value);
};
return (
<Box sx={{ display: 'flex', gap: 2 }}>
<Radio
checked={selectedValue === 'a'}
onChange={handleChange}
value="a"
name="radio-buttons"
slotProps={{ input: { 'aria-label': 'A' } }}
/>
<Radio
checked={selectedValue === 'b'}
onChange={handleChange}
value="b"
name="radio-buttons"
slotProps={{ input: { 'aria-label': 'B' } }}
/>
</Box>
);
}
| 1,390 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtons.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Radio from '@mui/joy/Radio';
export default function RadioButtons() {
const [selectedValue, setSelectedValue] = React.useState('a');
const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
setSelectedValue(event.target.value);
};
return (
<Box sx={{ display: 'flex', gap: 2 }}>
<Radio
checked={selectedValue === 'a'}
onChange={handleChange}
value="a"
name="radio-buttons"
slotProps={{ input: { 'aria-label': 'A' } }}
/>
<Radio
checked={selectedValue === 'b'}
onChange={handleChange}
value="b"
name="radio-buttons"
slotProps={{ input: { 'aria-label': 'B' } }}
/>
</Box>
);
}
| 1,391 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtons.tsx.preview | <Radio
checked={selectedValue === 'a'}
onChange={handleChange}
value="a"
name="radio-buttons"
slotProps={{ input: { 'aria-label': 'A' } }}
/>
<Radio
checked={selectedValue === 'b'}
onChange={handleChange}
value="b"
name="radio-buttons"
slotProps={{ input: { 'aria-label': 'B' } }}
/> | 1,392 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonsGroup.js | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import FormHelperText from '@mui/joy/FormHelperText';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function RadioButtonsGroup() {
return (
<FormControl>
<FormLabel>Gender</FormLabel>
<RadioGroup defaultValue="female" name="radio-buttons-group">
<Radio
value="female"
label="Female"
slotProps={{ input: { 'aria-describedby': 'female-helper-text' } }}
/>
<FormHelperText id="female-helper-text">
Helper text for this radio.
</FormHelperText>
<Radio value="male" label="Male" />
<Radio value="other" label="Other" />
</RadioGroup>
<FormHelperText>This is helper text.</FormHelperText>
</FormControl>
);
}
| 1,393 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonsGroup.tsx | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import FormHelperText from '@mui/joy/FormHelperText';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function RadioButtonsGroup() {
return (
<FormControl>
<FormLabel>Gender</FormLabel>
<RadioGroup defaultValue="female" name="radio-buttons-group">
<Radio
value="female"
label="Female"
slotProps={{ input: { 'aria-describedby': 'female-helper-text' } }}
/>
<FormHelperText id="female-helper-text">
Helper text for this radio.
</FormHelperText>
<Radio value="male" label="Male" />
<Radio value="other" label="Other" />
</RadioGroup>
<FormHelperText>This is helper text.</FormHelperText>
</FormControl>
);
}
| 1,394 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioButtonsGroup.tsx.preview | <FormControl>
<FormLabel>Gender</FormLabel>
<RadioGroup defaultValue="female" name="radio-buttons-group">
<Radio
value="female"
label="Female"
slotProps={{ input: { 'aria-describedby': 'female-helper-text' } }}
/>
<FormHelperText id="female-helper-text">
Helper text for this radio.
</FormHelperText>
<Radio value="male" label="Male" />
<Radio value="other" label="Other" />
</RadioGroup>
<FormHelperText>This is helper text.</FormHelperText>
</FormControl> | 1,395 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioColors.js | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function RadioColors() {
return (
<FormControl>
<FormLabel>Colors</FormLabel>
<RadioGroup defaultValue="medium" name="radio-buttons-group">
<Radio value="primary" label="Primary" color="primary" />
<Radio value="neutral" label="Neutral" color="neutral" />
<Radio value="danger" label="Danger" color="danger" />
<Radio value="success" label="Success" color="success" />
<Radio value="warning" label="Warning" color="warning" />
</RadioGroup>
</FormControl>
);
}
| 1,396 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioColors.tsx | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import Radio from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function RadioColors() {
return (
<FormControl>
<FormLabel>Colors</FormLabel>
<RadioGroup defaultValue="medium" name="radio-buttons-group">
<Radio value="primary" label="Primary" color="primary" />
<Radio value="neutral" label="Neutral" color="neutral" />
<Radio value="danger" label="Danger" color="danger" />
<Radio value="success" label="Success" color="success" />
<Radio value="warning" label="Warning" color="warning" />
</RadioGroup>
</FormControl>
);
}
| 1,397 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioColors.tsx.preview | <FormControl>
<FormLabel>Colors</FormLabel>
<RadioGroup defaultValue="medium" name="radio-buttons-group">
<Radio value="primary" label="Primary" color="primary" />
<Radio value="neutral" label="Neutral" color="neutral" />
<Radio value="danger" label="Danger" color="danger" />
<Radio value="success" label="Success" color="success" />
<Radio value="warning" label="Warning" color="warning" />
</RadioGroup>
</FormControl> | 1,398 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/radio-button/RadioFocus.js | import * as React from 'react';
import FormControl from '@mui/joy/FormControl';
import FormLabel from '@mui/joy/FormLabel';
import FormHelperText from '@mui/joy/FormHelperText';
import Radio, { radioClasses } from '@mui/joy/Radio';
import RadioGroup from '@mui/joy/RadioGroup';
export default function RadioFocus() {
return (
<FormControl>
<FormLabel>Focus</FormLabel>
<RadioGroup name="radio-buttons-group-focus">
<Radio value="default" label="Default" />
<Radio
value="relative"
label="Position relative"
sx={{ [`& .${radioClasses.radio}`]: { position: 'relative' } }}
/>
</RadioGroup>
<FormHelperText>
Select an option and use keyboard ↑↓ to see the focus outline
</FormHelperText>
</FormControl>
);
}
| 1,399 |
Subsets and Splits