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/avatar/ImageAvatars.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import Box from '@mui/joy/Box';
export default function ImageAvatars() {
return (
<Box sx={{ display: 'flex', gap: 2 }}>
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
</Box>
);
}
| 800 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/ImageAvatars.tsx.preview | <Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" /> | 801 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/InitialAvatars.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
export default function InitialAvatars() {
return <Avatar>RE</Avatar>;
}
| 802 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/InitialAvatars.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
export default function InitialAvatars() {
return <Avatar>RE</Avatar>;
}
| 803 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/InitialAvatars.tsx.preview | <Avatar>RE</Avatar> | 804 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/MaxAndTotalAvatars.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import AvatarGroup from '@mui/joy/AvatarGroup';
function clampAvatars(avatars, options = { max: 5 }) {
const { max = 5, total } = options;
let clampedMax = max < 2 ? 2 : max;
const totalAvatars = total || avatars.length;
if (totalAvatars === clampedMax) {
clampedMax += 1;
}
clampedMax = Math.min(totalAvatars + 1, clampedMax);
const maxAvatars = Math.min(avatars.length, clampedMax - 1);
const surplus = Math.max(totalAvatars - clampedMax, totalAvatars - maxAvatars, 0);
return { avatars: avatars.slice(0, maxAvatars).reverse(), surplus };
}
export default function MaxAndTotalAvatars() {
const dataFromTheServer = {
people: [
{
alt: 'Remy Sharp',
src: '/static/images/avatar/1.jpg',
},
{
alt: 'Travis Howard',
src: '/static/images/avatar/2.jpg',
},
{
alt: 'Agnes Walker',
src: '/static/images/avatar/4.jpg',
},
{
alt: 'Trevor Henderson',
src: '/static/images/avatar/5.jpg',
},
],
total: 24,
};
const { avatars, surplus } = clampAvatars(dataFromTheServer.people, {
max: 5,
total: dataFromTheServer.total,
});
return (
<AvatarGroup>
{avatars.map((avatar) => (
<Avatar key={avatar.alt} {...avatar} />
))}
{!!surplus && <Avatar>+{surplus}</Avatar>}
</AvatarGroup>
);
}
| 805 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/MaxAndTotalAvatars.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import AvatarGroup from '@mui/joy/AvatarGroup';
function clampAvatars<T>(
avatars: Array<T>,
options: { max?: number; total?: number } = { max: 5 },
) {
const { max = 5, total } = options;
let clampedMax = max < 2 ? 2 : max;
const totalAvatars = total || avatars.length;
if (totalAvatars === clampedMax) {
clampedMax += 1;
}
clampedMax = Math.min(totalAvatars + 1, clampedMax);
const maxAvatars = Math.min(avatars.length, clampedMax - 1);
const surplus = Math.max(totalAvatars - clampedMax, totalAvatars - maxAvatars, 0);
return { avatars: avatars.slice(0, maxAvatars).reverse(), surplus };
}
export default function MaxAndTotalAvatars() {
const dataFromTheServer = {
people: [
{
alt: 'Remy Sharp',
src: '/static/images/avatar/1.jpg',
},
{
alt: 'Travis Howard',
src: '/static/images/avatar/2.jpg',
},
{
alt: 'Agnes Walker',
src: '/static/images/avatar/4.jpg',
},
{
alt: 'Trevor Henderson',
src: '/static/images/avatar/5.jpg',
},
],
total: 24,
};
const { avatars, surplus } = clampAvatars(dataFromTheServer.people, {
max: 5,
total: dataFromTheServer.total,
});
return (
<AvatarGroup>
{avatars.map((avatar) => (
<Avatar key={avatar.alt} {...avatar} />
))}
{!!surplus && <Avatar>+{surplus}</Avatar>}
</AvatarGroup>
);
}
| 806 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/MaxAndTotalAvatars.tsx.preview | <AvatarGroup>
{avatars.map((avatar) => (
<Avatar key={avatar.alt} {...avatar} />
))}
{!!surplus && <Avatar>+{surplus}</Avatar>}
</AvatarGroup> | 807 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/OverlapAvatarGroup.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import AvatarGroup from '@mui/joy/AvatarGroup';
export default function OverlapAvatarGroup() {
return (
<AvatarGroup sx={{ flexDirection: 'row-reverse' }}>
<Avatar>+3</Avatar>
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
</AvatarGroup>
);
}
| 808 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/OverlapAvatarGroup.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import AvatarGroup from '@mui/joy/AvatarGroup';
export default function OverlapAvatarGroup() {
return (
<AvatarGroup sx={{ flexDirection: 'row-reverse' }}>
<Avatar>+3</Avatar>
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
</AvatarGroup>
);
}
| 809 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/OverlapAvatarGroup.tsx.preview | <AvatarGroup sx={{ flexDirection: 'row-reverse' }}>
<Avatar>+3</Avatar>
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
</AvatarGroup> | 810 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/VerticalAvatarGroup.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import AvatarGroup from '@mui/joy/AvatarGroup';
export default function VerticalAvatarGroup() {
return (
<AvatarGroup sx={{ writingMode: 'vertical-rl' }}>
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
<Avatar sx={{ transform: 'rotate(-90deg)' }}>+3</Avatar>
</AvatarGroup>
);
}
| 811 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/VerticalAvatarGroup.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import AvatarGroup from '@mui/joy/AvatarGroup';
export default function VerticalAvatarGroup() {
return (
<AvatarGroup sx={{ writingMode: 'vertical-rl' }}>
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
<Avatar sx={{ transform: 'rotate(-90deg)' }}>+3</Avatar>
</AvatarGroup>
);
}
| 812 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/VerticalAvatarGroup.tsx.preview | <AvatarGroup sx={{ writingMode: 'vertical-rl' }}>
<Avatar alt="Remy Sharp" src="/static/images/avatar/1.jpg" />
<Avatar alt="Travis Howard" src="/static/images/avatar/2.jpg" />
<Avatar alt="Cindy Baker" src="/static/images/avatar/3.jpg" />
<Avatar sx={{ transform: 'rotate(-90deg)' }}>+3</Avatar>
</AvatarGroup> | 813 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/avatar/avatar.md | ---
productId: joy-ui
title: React Avatar component
components: Avatar, AvatarGroup, SvgIcon
githubLabel: 'component: avatar'
---
# Avatar
<p class="description">An avatar is a graphical representation of a user's identity.</p>
{{"component": "modules/components/ComponentLinkHeader.js"}}
## Introduction
The Avatar component can be used to display graphical information about a user in places such as menus, tables, and chats.
{{"demo": "AvatarUsage.js", "hideToolbar": true, "bg": "gradient"}}
## Basics
```jsx
import Avatar from '@mui/joy/Avatar';
```
By default, the Avatar component displays a generic Person Icon.
You can replace this icon with a text string or an image.
{{"demo": "BasicAvatars.js"}}
### Text Avatar
Wrap the Avatar component around a string to display text.
Note that the Avatar is designed to comfortably fit two letters at most—for instance, a user's initials:
{{"demo": "InitialAvatars.js"}}
### Image Avatar
Insert images into the Avatar by defining a path inside the `src` prop, just like you would with an HTML `<img>` element.
Make sure to to write a meaningful description for the `alt` prop.
{{"demo": "ImageAvatars.js"}}
#### Image fallbacks
If an error occurs while loading the Avatar's image, it will fall back to the following alternatives (in this order):
1. The provided child string
2. The first letter of the alt text
3. The default generic icon
{{"demo": "FallbackAvatars.js"}}
## Customization
### Variants
The Avatar component supports Joy UI's four [global variants](/joy-ui/main-features/global-variants/): `solid`, `soft` (default), `outlined`, and `plain`.
{{"demo": "AvatarVariants.js"}}
:::info
To learn how to add your own variants, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
Note that you lose the global variants when you add custom variants.
:::
### Sizes
The Avatar component comes in three sizes: `sm`, `md` (default), and `lg`:
{{"demo": "AvatarSizes.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).
:::
## Usage with Avatar Group
```jsx
import AvatarGroup from '@mui/joy/AvatarGroup';
```
Use the Avatar Group component to group multiple Avatars together.
{{"demo": "GroupedAvatars.js"}}
### Quantity within a group
The Avatar Group does not provide built-in props to control the maximum or the total number of Avatars within a group.
This is intentionally left open-ended to give you broader options for customization.
The demo below shows an example of an Avatar Group that maxes out at five; all Avatars beyond the first four are lumped together in the fifth Avatar, which displays the total number hidden:
{{"demo": "MaxAndTotalAvatars.js"}}
### Consistent appearance
The Avatar component exposes meaningful CSS variables to communicate with Avatar Group.
You can apply those variables to other non-Avatar components to mimic the Avatar's appearance inside of a group.
This customization technique makes your interface more resilient to changes, as any style changes applied to the Avatar will also be applied to the other components in the group.
Here is an example using an Icon Button with its styles defined by the Avatar's CSS variables:
{{"demo": "EllipsisAvatarAction.js"}}
### Overlapping order
By default, the first Avatar in the group sits behind the second, which sits behind the third, and so on.
You can reverse the overlapping order by reversing the order of the Avatars and using the CSS `flexDirection: row-reverse` property in the Avatar Group:
{{"demo": "OverlapAvatarGroup.js"}}
### Vertical stacking
To render the Avatar Group vertically, add the CSS `writing-mode: vertical-rl` property and rotate the interior element (if one is present) by -90 degrees.
:::success
This approach is preferable because it preserves the overlapping offset between Avatars; the alternative—`flexDirection: column`—does not.
:::
{{"demo": "VerticalAvatarGroup.js"}}
## Usage with Badge
```jsx
import Badge from '@mui/joy/Badge';
```
Combine the Avatar component with the [Badge](/joy-ui/react-badge/) to visually communicate more complex information about a user's status:
{{"demo": "BadgeAvatars.js"}}
## CSS variables playground
Play around with the CSS variables available to the Avatar component to see how the design changes.
You can use these to customize the component with both the `sx` prop and the theme.
{{"demo": "AvatarGroupVariables.js", "hideToolbar": true, "bg": "gradient"}}
## Anatomy
The Avatar component is composed of a root `<div>` that may wrap around an `<svg>`, an `<img>`, or a string:
```html
<div class="MuiAvatar-root">
<!-- Avatar contents -->
</div>
```
| 814 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/AccessibleBadges.js | import * as React from 'react';
import IconButton from '@mui/joy/IconButton';
import Badge from '@mui/joy/Badge';
import MailIcon from '@mui/icons-material/Mail';
function notificationsLabel(count) {
if (count === 0) {
return 'no notifications';
}
if (count > 99) {
return 'more than 99 notifications';
}
return `${count} notifications`;
}
export default function AccessibleBadges() {
return (
<IconButton color="neutral" aria-label={notificationsLabel(100)}>
<Badge badgeContent={100} badgeInset="-20%">
<MailIcon />
</Badge>
</IconButton>
);
}
| 815 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/AccessibleBadges.tsx | import * as React from 'react';
import IconButton from '@mui/joy/IconButton';
import Badge from '@mui/joy/Badge';
import MailIcon from '@mui/icons-material/Mail';
function notificationsLabel(count: number) {
if (count === 0) {
return 'no notifications';
}
if (count > 99) {
return 'more than 99 notifications';
}
return `${count} notifications`;
}
export default function AccessibleBadges() {
return (
<IconButton color="neutral" aria-label={notificationsLabel(100)}>
<Badge badgeContent={100} badgeInset="-20%">
<MailIcon />
</Badge>
</IconButton>
);
}
| 816 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/AccessibleBadges.tsx.preview | <IconButton color="neutral" aria-label={notificationsLabel(100)}>
<Badge badgeContent={100} badgeInset="-20%">
<MailIcon />
</Badge>
</IconButton> | 817 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeAlignment.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import IconButton from '@mui/joy/IconButton';
import ArrowUpward from '@mui/icons-material/ArrowUpward';
import ArrowDownward from '@mui/icons-material/ArrowDownward';
import HighlightedCode from 'docs/src/modules/components/HighlightedCode';
import BrandingProvider from 'docs/src/BrandingProvider';
export default function BadgeAlignment() {
const [anchorOrigin, setAnchorOrigin] = React.useState({
vertical: 'top',
horizontal: 'right',
});
const jsx = `
<Badge
anchorOrigin={{
vertical: '${anchorOrigin?.vertical}',
horizontal: '${anchorOrigin?.horizontal}',
}}
>
`;
return (
<Box sx={{ mt: 2, textAlign: 'center' }}>
<Box sx={{ p: 5, position: 'relative', display: 'inline-block' }}>
<Badge anchorOrigin={anchorOrigin} badgeInset="14%">
<Avatar size="lg" src="/static/images/avatar/2.jpg" />
</Badge>
<IconButton
color="neutral"
size="sm"
aria-label="top left"
onClick={() => setAnchorOrigin({ vertical: 'top', horizontal: 'left' })}
sx={{ borderRadius: 'xl', position: 'absolute', top: 0, left: 0 }}
>
<ArrowDownward sx={{ transform: 'rotate(-45deg)' }} />
</IconButton>
<IconButton
color="neutral"
size="sm"
aria-label="top right"
onClick={() => setAnchorOrigin({ vertical: 'top', horizontal: 'right' })}
sx={{ borderRadius: 'xl', position: 'absolute', top: 0, right: 0 }}
>
<ArrowDownward sx={{ transform: 'rotate(45deg)' }} />
</IconButton>
<IconButton
color="neutral"
size="sm"
aria-label="bottom right"
onClick={() => setAnchorOrigin({ vertical: 'bottom', horizontal: 'left' })}
sx={{ borderRadius: 'xl', position: 'absolute', bottom: 0, left: 0 }}
>
<ArrowUpward sx={{ transform: 'rotate(45deg)' }} />
</IconButton>
<IconButton
color="neutral"
size="sm"
aria-label="bottom left"
onClick={() =>
setAnchorOrigin({ vertical: 'bottom', horizontal: 'right' })
}
sx={{ borderRadius: 'xl', position: 'absolute', bottom: 0, right: 0 }}
>
<ArrowUpward sx={{ transform: 'rotate(-45deg)' }} />
</IconButton>
</Box>
<BrandingProvider mode="dark">
<HighlightedCode
code={jsx}
language="jsx"
sx={{ minWidth: 300, textAlign: 'left' }}
/>
</BrandingProvider>
</Box>
);
}
| 818 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeAlignment.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import Badge, { BadgeProps } from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import IconButton from '@mui/joy/IconButton';
import ArrowUpward from '@mui/icons-material/ArrowUpward';
import ArrowDownward from '@mui/icons-material/ArrowDownward';
import HighlightedCode from 'docs/src/modules/components/HighlightedCode';
import BrandingProvider from 'docs/src/BrandingProvider';
export default function BadgeAlignment() {
const [anchorOrigin, setAnchorOrigin] = React.useState<BadgeProps['anchorOrigin']>(
{
vertical: 'top',
horizontal: 'right',
},
);
const jsx = `
<Badge
anchorOrigin={{
vertical: '${anchorOrigin?.vertical}',
horizontal: '${anchorOrigin?.horizontal}',
}}
>
`;
return (
<Box sx={{ mt: 2, textAlign: 'center' }}>
<Box sx={{ p: 5, position: 'relative', display: 'inline-block' }}>
<Badge anchorOrigin={anchorOrigin} badgeInset="14%">
<Avatar size="lg" src="/static/images/avatar/2.jpg" />
</Badge>
<IconButton
color="neutral"
size="sm"
aria-label="top left"
onClick={() => setAnchorOrigin({ vertical: 'top', horizontal: 'left' })}
sx={{ borderRadius: 'xl', position: 'absolute', top: 0, left: 0 }}
>
<ArrowDownward sx={{ transform: 'rotate(-45deg)' }} />
</IconButton>
<IconButton
color="neutral"
size="sm"
aria-label="top right"
onClick={() => setAnchorOrigin({ vertical: 'top', horizontal: 'right' })}
sx={{ borderRadius: 'xl', position: 'absolute', top: 0, right: 0 }}
>
<ArrowDownward sx={{ transform: 'rotate(45deg)' }} />
</IconButton>
<IconButton
color="neutral"
size="sm"
aria-label="bottom right"
onClick={() => setAnchorOrigin({ vertical: 'bottom', horizontal: 'left' })}
sx={{ borderRadius: 'xl', position: 'absolute', bottom: 0, left: 0 }}
>
<ArrowUpward sx={{ transform: 'rotate(45deg)' }} />
</IconButton>
<IconButton
color="neutral"
size="sm"
aria-label="bottom left"
onClick={() =>
setAnchorOrigin({ vertical: 'bottom', horizontal: 'right' })
}
sx={{ borderRadius: 'xl', position: 'absolute', bottom: 0, right: 0 }}
>
<ArrowUpward sx={{ transform: 'rotate(-45deg)' }} />
</IconButton>
</Box>
<BrandingProvider mode="dark">
<HighlightedCode
code={jsx}
language="jsx"
sx={{ minWidth: 300, textAlign: 'left' }}
/>
</BrandingProvider>
</Box>
);
}
| 819 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeColors.js | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Typography from '@mui/joy/Typography';
export default function BadgeColors() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={'P'} color="primary">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'N'} color="neutral">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'D'} color="danger">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'S'} color="success">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'W'} color="warning">
<Typography fontSize="xl">💌</Typography>
</Badge>
</Box>
);
}
| 820 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeColors.tsx | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Typography from '@mui/joy/Typography';
export default function BadgeColors() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={'P'} color="primary">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'N'} color="neutral">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'D'} color="danger">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'S'} color="success">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'W'} color="warning">
<Typography fontSize="xl">💌</Typography>
</Badge>
</Box>
);
}
| 821 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeColors.tsx.preview | <Badge badgeContent={'P'} color="primary">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'N'} color="neutral">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'D'} color="danger">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'S'} color="success">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={'W'} color="warning">
<Typography fontSize="xl">💌</Typography>
</Badge> | 822 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeInset.js | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import Badge from '@mui/joy/Badge';
export default function BadgeInset() {
return (
<Badge badgeInset="14%" color="danger">
<Avatar src="/static/images/avatar/1.jpg" />
</Badge>
);
}
| 823 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeInset.tsx | import * as React from 'react';
import Avatar from '@mui/joy/Avatar';
import Badge from '@mui/joy/Badge';
export default function BadgeInset() {
return (
<Badge badgeInset="14%" color="danger">
<Avatar src="/static/images/avatar/1.jpg" />
</Badge>
);
}
| 824 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeInset.tsx.preview | <Badge badgeInset="14%" color="danger">
<Avatar src="/static/images/avatar/1.jpg" />
</Badge> | 825 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeMax.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Badge from '@mui/joy/Badge';
import MailIcon from '@mui/icons-material/Mail';
export default function BadgeMax() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={99}>
<MailIcon />
</Badge>
<Badge badgeContent={100} badgeInset="0 -6px 0 0">
<MailIcon />
</Badge>
<Badge badgeContent={1000} max={999} badgeInset="0 -12px 0 0">
<MailIcon />
</Badge>
</Box>
);
}
| 826 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeMax.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Badge from '@mui/joy/Badge';
import MailIcon from '@mui/icons-material/Mail';
export default function BadgeMax() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={99}>
<MailIcon />
</Badge>
<Badge badgeContent={100} badgeInset="0 -6px 0 0">
<MailIcon />
</Badge>
<Badge badgeContent={1000} max={999} badgeInset="0 -12px 0 0">
<MailIcon />
</Badge>
</Box>
);
}
| 827 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeMax.tsx.preview | <Badge badgeContent={99}>
<MailIcon />
</Badge>
<Badge badgeContent={100} badgeInset="0 -6px 0 0">
<MailIcon />
</Badge>
<Badge badgeContent={1000} max={999} badgeInset="0 -12px 0 0">
<MailIcon />
</Badge> | 828 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeSizes.js | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Typography from '@mui/joy/Typography';
export default function BadgeSizes() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={10} size="sm">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={20} size="md">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={30} size="lg">
<Typography fontSize="xl">💌</Typography>
</Badge>
</Box>
);
}
| 829 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeSizes.tsx | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Typography from '@mui/joy/Typography';
export default function BadgeSizes() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={10} size="sm">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={20} size="md">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={30} size="lg">
<Typography fontSize="xl">💌</Typography>
</Badge>
</Box>
);
}
| 830 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeSizes.tsx.preview | <Badge badgeContent={10} size="sm">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={20} size="md">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={30} size="lg">
<Typography fontSize="xl">💌</Typography>
</Badge> | 831 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeUsage.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Badge from '@mui/joy/Badge';
import JoyUsageDemo from 'docs/src/modules/components/JoyUsageDemo';
export default function BadgeUsage() {
return (
<JoyUsageDemo
componentName="Badge"
data={[
{
propName: 'variant',
knob: 'radio',
defaultValue: 'solid',
options: ['plain', 'outlined', 'soft', 'solid'],
},
{
propName: 'color',
knob: 'color',
defaultValue: 'primary',
},
{
propName: 'size',
knob: 'radio',
options: ['sm', 'md', 'lg'],
defaultValue: 'md',
},
{
propName: 'badgeContent',
knob: 'input',
},
]}
renderDemo={(props) => (
<Badge {...props}>
<Box
sx={{
bgcolor: 'background.level3',
borderRadius: 'xs',
width: 48,
height: 48,
}}
/>
</Badge>
)}
/>
);
}
| 832 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeVariants.js | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Typography from '@mui/joy/Typography';
export default function BadgeVariants() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={1} variant="solid">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={2} variant="soft">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={3} variant="outlined">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={4} variant="plain">
<Typography fontSize="xl">💌</Typography>
</Badge>
</Box>
);
}
| 833 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeVariants.tsx | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Typography from '@mui/joy/Typography';
export default function BadgeVariants() {
return (
<Box sx={{ display: 'flex', gap: 4 }}>
<Badge badgeContent={1} variant="solid">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={2} variant="soft">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={3} variant="outlined">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={4} variant="plain">
<Typography fontSize="xl">💌</Typography>
</Badge>
</Box>
);
}
| 834 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeVariants.tsx.preview | <Badge badgeContent={1} variant="solid">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={2} variant="soft">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={3} variant="outlined">
<Typography fontSize="xl">💌</Typography>
</Badge>
<Badge badgeContent={4} variant="plain">
<Typography fontSize="xl">💌</Typography>
</Badge> | 835 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeVisibility.js | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Switch from '@mui/joy/Switch';
import Typography from '@mui/joy/Typography';
export default function BadgeVisibility() {
const [invisible, setInvisible] = React.useState(false);
return (
<Box
sx={{
display: 'flex',
alignItems: 'center',
gap: 2,
minWidth: 200,
justifyContent: 'space-between',
}}
>
<Badge badgeContent={12} invisible={invisible}>
<Typography fontSize="xl">🛍</Typography>
</Badge>
<Switch
startDecorator="invisible"
checked={invisible}
onChange={(event) => setInvisible(event.target.checked)}
variant={invisible ? 'solid' : 'outlined'}
/>
</Box>
);
}
| 836 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeVisibility.tsx | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import Switch from '@mui/joy/Switch';
import Typography from '@mui/joy/Typography';
export default function BadgeVisibility() {
const [invisible, setInvisible] = React.useState(false);
return (
<Box
sx={{
display: 'flex',
alignItems: 'center',
gap: 2,
minWidth: 200,
justifyContent: 'space-between',
}}
>
<Badge badgeContent={12} invisible={invisible}>
<Typography fontSize="xl">🛍</Typography>
</Badge>
<Switch
startDecorator="invisible"
checked={invisible}
onChange={(event) => setInvisible(event.target.checked)}
variant={invisible ? 'solid' : 'outlined'}
/>
</Box>
);
}
| 837 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/BadgeVisibility.tsx.preview | <Badge badgeContent={12} invisible={invisible}>
<Typography fontSize="xl">🛍</Typography>
</Badge>
<Switch
startDecorator="invisible"
checked={invisible}
onChange={(event) => setInvisible(event.target.checked)}
variant={invisible ? 'solid' : 'outlined'}
/> | 838 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/ContentBadge.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Badge from '@mui/joy/Badge';
import Typography from '@mui/joy/Typography';
import Warning from '@mui/icons-material/Warning';
export default function ContentBadge() {
return (
<Box sx={{ display: 'flex', gap: 3 }}>
<Badge badgeContent={4}>
<Typography fontSize="xl">🛍</Typography>
</Badge>
<Badge badgeContent="❕">
<Typography fontSize="xl">🔔</Typography>
</Badge>
<Badge variant="plain" color="danger" badgeContent={<Warning />}>
<Typography fontSize="xl">🪫</Typography>
</Badge>
</Box>
);
}
| 839 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/ContentBadge.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Badge from '@mui/joy/Badge';
import Typography from '@mui/joy/Typography';
import Warning from '@mui/icons-material/Warning';
export default function ContentBadge() {
return (
<Box sx={{ display: 'flex', gap: 3 }}>
<Badge badgeContent={4}>
<Typography fontSize="xl">🛍</Typography>
</Badge>
<Badge badgeContent="❕">
<Typography fontSize="xl">🔔</Typography>
</Badge>
<Badge variant="plain" color="danger" badgeContent={<Warning />}>
<Typography fontSize="xl">🪫</Typography>
</Badge>
</Box>
);
}
| 840 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/ContentBadge.tsx.preview | <Badge badgeContent={4}>
<Typography fontSize="xl">🛍</Typography>
</Badge>
<Badge badgeContent="❕">
<Typography fontSize="xl">🔔</Typography>
</Badge>
<Badge variant="plain" color="danger" badgeContent={<Warning />}>
<Typography fontSize="xl">🪫</Typography>
</Badge> | 841 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/NumberBadge.js | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import IconButton from '@mui/joy/IconButton';
import Typography from '@mui/joy/Typography';
import Checkbox from '@mui/joy/Checkbox';
import Add from '@mui/icons-material/Add';
import Remove from '@mui/icons-material/Remove';
export default function NumberBadge() {
const [count, setCount] = React.useState(0);
const [showZero, setShowZero] = React.useState(false);
return (
<Box
sx={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 2,
mt: 4,
}}
>
<Badge badgeContent={count} showZero={showZero}>
<Typography level="h1" component="h2">
🛍
</Typography>
</Badge>
<Box
sx={{
display: 'flex',
alignItems: 'center',
gap: 2,
pt: 4,
mb: 2,
borderTop: '1px solid',
borderColor: 'background.level1',
}}
>
<IconButton
size="sm"
variant="outlined"
onClick={() => setCount((c) => c - 1)}
>
<Remove />
</IconButton>
<Typography fontWeight="md" textColor="text.secondary">
{count}
</Typography>
<IconButton
size="sm"
variant="outlined"
onClick={() => setCount((c) => c + 1)}
>
<Add />
</IconButton>
</Box>
<Checkbox
onChange={(event) => setShowZero(event.target.checked)}
checked={showZero}
label="show zero"
/>
</Box>
);
}
| 842 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/NumberBadge.tsx | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Box from '@mui/joy/Box';
import IconButton from '@mui/joy/IconButton';
import Typography from '@mui/joy/Typography';
import Checkbox from '@mui/joy/Checkbox';
import Add from '@mui/icons-material/Add';
import Remove from '@mui/icons-material/Remove';
export default function NumberBadge() {
const [count, setCount] = React.useState(0);
const [showZero, setShowZero] = React.useState(false);
return (
<Box
sx={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 2,
mt: 4,
}}
>
<Badge badgeContent={count} showZero={showZero}>
<Typography level="h1" component="h2">
🛍
</Typography>
</Badge>
<Box
sx={{
display: 'flex',
alignItems: 'center',
gap: 2,
pt: 4,
mb: 2,
borderTop: '1px solid',
borderColor: 'background.level1',
}}
>
<IconButton
size="sm"
variant="outlined"
onClick={() => setCount((c) => c - 1)}
>
<Remove />
</IconButton>
<Typography fontWeight="md" textColor="text.secondary">
{count}
</Typography>
<IconButton
size="sm"
variant="outlined"
onClick={() => setCount((c) => c + 1)}
>
<Add />
</IconButton>
</Box>
<Checkbox
onChange={(event) => setShowZero(event.target.checked)}
checked={showZero}
label="show zero"
/>
</Box>
);
}
| 843 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/SimpleBadge.js | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Typography from '@mui/joy/Typography';
export default function SimpleBadge() {
return (
<Badge>
<Typography fontSize="xl">🛒</Typography>
</Badge>
);
}
| 844 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/SimpleBadge.tsx | import * as React from 'react';
import Badge from '@mui/joy/Badge';
import Typography from '@mui/joy/Typography';
export default function SimpleBadge() {
return (
<Badge>
<Typography fontSize="xl">🛒</Typography>
</Badge>
);
}
| 845 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/SimpleBadge.tsx.preview | <Badge>
<Typography fontSize="xl">🛒</Typography>
</Badge> | 846 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/badge/badge.md | ---
productId: joy-ui
title: React Badge component
components: Badge
githubLabel: 'component: badge'
unstyled: /base-ui/react-badge/
---
# Badge
<p class="description">The Badge component generates a small label that is attached to its child element.</p>
{{"component": "modules/components/ComponentLinkHeader.js"}}
## Introduction
A badge is a small descriptor for UI elements.
It typically sits on or near an element and indicates the status of that element by displaying a number, icon, or other short set of characters.
{{"demo": "BadgeUsage.js", "hideToolbar": true, "bg": "gradient"}}
## Basics
```jsx
import Badge from '@mui/joy/Badge';
```
The Badge component wraps around the UI element that it's attached to.
Its default appearance is a dot in the app's `primary` color that sits on the top-right corner of the element that it's attached to.
{{"demo": "SimpleBadge.js"}}
### Content
Use a string or a number as a value for the `badgeContent` prop to display content inside the Badge.
{{"demo": "ContentBadge.js"}}
### Numbers
The following props are useful when `badgeContent` is a number.
#### showZero
By default, the Badge will be automatically hidden when `badgeContent={0}`.
You can override this behavior with the `showZero` prop:
{{"demo": "NumberBadge.js"}}
#### Maximum value
Use the `max` prop to cap the content to a maximum numerical value.
{{"demo": "BadgeMax.js"}}
## Customization
### Variants
The Badge component supports Joy UI's four [global variants](/joy-ui/main-features/global-variants/): `solid` (default), `soft` , `outlined`, and `plain`.
{{"demo": "BadgeVariants.js"}}
:::info
To learn how to add your own variants, check out [Themed components—Extend variants](/joy-ui/customization/themed-components/#extend-variants).
Note that you lose the global variants when you add custom variants.
:::
### Sizes
The Badge component comes in three sizes: `sm`, `md` (default), and `lg`:
{{"demo": "BadgeSizes.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.
{{"demo": "BadgeColors.js"}}
### Visibility
Use the `invisible` prop to control the Badge's visibility.
:::warning
If [`showZero`](#numbers) and `invisible` are both applied at the same time, then the Badge will still be visible when `badgeContent={0}`.
:::
{{"demo": "BadgeVisibility.js"}}
### Position
By default, the Badge sits on the top-right corner of the element that it's attached to.
Use the `anchorOrigin` prop to change the position of the Badge according to its `vertical` (top or bottom) and `horizontal` (left or right) placement.
Try clicking the arrows in the demo below to change the position of the Badge:
{{"demo": "BadgeAlignment.js", "hideToolbar": true}}
### Inset
Use the `badgeInset` prop to fine-tune the position of the Badge relative to the element that it's attached to.
This prop accepts a string composed of numbers expressed in units of `px`, `%`, `em`, or `rem`. (This syntax corresponds to the [inset CSS property](https://developer.mozilla.org/en-US/docs/Web/CSS/inset).)
This string defines the inset from the Badge's [`anchorOrigin`](#position)—for instance, the demo below pushes the Badge 14% closer to the center of its child element (relative to the top-right corner) along both the vertical and horizontal axes:
{{"demo": "BadgeInset.js"}}
If you pass two unit-numbers to the `badgeInset` prop—for example`"50px 10px"`—the first number applies to the vertical axis, and the second applies horizontally.
If you pass four unit-numbers to the prop—such as `"0 -10px 0 5px"`, they are applied clockwise starting from the top.
## Accessibility
Screen readers may not provide users with enough information about a badge's contents.
To make your Badge accessible, you must provide a full description with `aria-label`, as shown in the demo below:
{{"demo": "AccessibleBadges.js"}}
## Anatomy
The Badge component is composed of a root `<span>` that houses the element that the Badge is attached to, followed by a `<span>` to represent the Badge itself:
```html
<span class="MuiBadge-root">
<!-- the element the Badge is attached to -->
<span class="MuiBadge-badge">
<!-- Badge content -->
</span>
</span>
```
| 847 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/box/box.md | ---
productId: joy-ui
title: React Box
components: Box
githubLabel: 'component: Box'
---
# Box
<p class="description">The Box component is a generic, theme-aware container with access to CSS utilities from MUI System.</p>
:::warning
Please refer to the [Box](/system/react-box/) component page in the MUI System docs for demos and details on usage.
The Box component is a part of the standalone [MUI System](/system/getting-started/) utility library.
It is re-exported from `@mui/joy` for your convenience.
:::
| 848 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BasicBreadcrumbs.js | import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
export default function BasicBreadcrumbs() {
return (
<Breadcrumbs aria-label="breadcrumbs">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#basics">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
);
}
| 849 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BasicBreadcrumbs.tsx | import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
export default function BasicBreadcrumbs() {
return (
<Breadcrumbs aria-label="breadcrumbs">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item: string) => (
<Link key={item} color="neutral" href="#basics">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
);
}
| 850 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BasicBreadcrumbs.tsx.preview | <Breadcrumbs aria-label="breadcrumbs">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item: string) => (
<Link key={item} color="neutral" href="#basics">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs> | 851 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsSizes.js | import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Stack from '@mui/joy/Stack';
import Typography from '@mui/joy/Typography';
export default function BreadcrumbsSizes() {
return (
<Stack sx={{ display: 'flex', alignItems: 'center' }}>
<Breadcrumbs separator="—" aria-label="breadcrumbs" size="sm">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#sizes">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
<Breadcrumbs separator="—" aria-label="breadcrumbs" size="md">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#sizes">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
<Breadcrumbs separator="—" aria-label="breadcrumbs" size="lg">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#sizes">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
</Stack>
);
}
| 852 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsSizes.tsx | import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Stack from '@mui/joy/Stack';
import Typography from '@mui/joy/Typography';
export default function BreadcrumbsSizes() {
return (
<Stack sx={{ display: 'flex', alignItems: 'center' }}>
<Breadcrumbs separator="—" aria-label="breadcrumbs" size="sm">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#sizes">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
<Breadcrumbs separator="—" aria-label="breadcrumbs" size="md">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#sizes">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
<Breadcrumbs separator="—" aria-label="breadcrumbs" size="lg">
{['Home', 'TV Shows', 'Futurama', 'Characters'].map((item) => (
<Link key={item} color="neutral" href="#sizes">
{item}
</Link>
))}
<Typography>Dr. Zoidberg</Typography>
</Breadcrumbs>
</Stack>
);
}
| 853 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsUsage.js | import * as React from 'react';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import JoyUsageDemo from 'docs/src/modules/components/JoyUsageDemo';
export default function BreadcrumbsUsage() {
return (
<JoyUsageDemo
componentName="Breadcrumbs"
data={[
{
propName: 'size',
knob: 'radio',
options: ['sm', 'md', 'lg'],
defaultValue: 'md',
},
{
propName: 'separator',
knob: 'input',
defaultValue: '/',
},
{
propName: 'children',
defaultValue: '<Link />\n ...',
},
]}
renderDemo={(props) => (
<Breadcrumbs {...props} aria-label="breadcrumbs">
<Link
// The `preventDefault` is for demonstration purposes, generally, you don't need it in your application
onClick={(event) => event.preventDefault()}
color="neutral"
href="/"
>
MUI
</Link>
<Link
// The `preventDefault` is for demonstration purposes, generally, you don't need it in your application
onClick={(event) => event.preventDefault()}
color="neutral"
href="/joy-ui/getting-started/installation/"
>
Joy
</Link>
<Typography>Breadcrumbs</Typography>
</Breadcrumbs>
)}
/>
);
}
| 854 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsVariables.js | import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
import JoyVariablesDemo from 'docs/src/modules/components/JoyVariablesDemo';
export default function BreadcrumbsVariables() {
return (
<JoyVariablesDemo
componentName="Breadcrumbs"
data={[
{
var: '--Breadcrumbs-gap',
defaultValue: '4px',
},
]}
renderDemo={(sx) => (
<Breadcrumbs sx={sx}>
{['Menu 1', 'Menu 2'].map((item) => (
<Link key={item} color="neutral" href="#css-variable-playground">
{item}
</Link>
))}
<Typography>Menu 3</Typography>
</Breadcrumbs>
)}
/>
);
}
| 855 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsVariables.tsx | import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
import JoyVariablesDemo from 'docs/src/modules/components/JoyVariablesDemo';
export default function BreadcrumbsVariables() {
return (
<JoyVariablesDemo
componentName="Breadcrumbs"
data={[
{
var: '--Breadcrumbs-gap',
defaultValue: '4px',
},
]}
renderDemo={(sx) => (
<Breadcrumbs sx={sx}>
{['Menu 1', 'Menu 2'].map((item) => (
<Link key={item} color="neutral" href="#css-variable-playground">
{item}
</Link>
))}
<Typography>Menu 3</Typography>
</Breadcrumbs>
)}
/>
);
}
| 856 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsWithIcon.js | import PublicIcon from '@mui/icons-material/Public';
import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
export default function BreadcrumbsWithIcon() {
return (
<Breadcrumbs separator="›" aria-label="breadcrumbs">
<Link color="primary" href="/">
<PublicIcon sx={{ mr: 0.5 }} />
United States
</Link>
{['Springfield', 'Simpson'].map((item) => (
<Link key={item} color="success" href="#usage-with-link-and-typography">
{item}
</Link>
))}
<Typography>Homer</Typography>
</Breadcrumbs>
);
}
| 857 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsWithIcon.tsx | import PublicIcon from '@mui/icons-material/Public';
import * as React from 'react';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
export default function BreadcrumbsWithIcon() {
return (
<Breadcrumbs separator="›" aria-label="breadcrumbs">
<Link color="primary" href="/">
<PublicIcon sx={{ mr: 0.5 }} />
United States
</Link>
{['Springfield', 'Simpson'].map((item) => (
<Link key={item} color="success" href="#usage-with-link-and-typography">
{item}
</Link>
))}
<Typography>Homer</Typography>
</Breadcrumbs>
);
}
| 858 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsWithIcon.tsx.preview | <Breadcrumbs separator="›" aria-label="breadcrumbs">
<Link color="primary" href="/">
<PublicIcon sx={{ mr: 0.5 }} />
United States
</Link>
{['Springfield', 'Simpson'].map((item) => (
<Link key={item} color="success" href="#usage-with-link-and-typography">
{item}
</Link>
))}
<Typography>Homer</Typography>
</Breadcrumbs> | 859 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsWithMenu.js | import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Button from '@mui/joy/Button';
import Link from '@mui/joy/Link';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import * as React from 'react';
export default function BreadcrumbsWithMenu() {
const [anchorEl, setAnchorEl] = React.useState(null);
const open = Boolean(anchorEl);
const handleClick = (event) => {
if (event) {
setAnchorEl(event.currentTarget);
}
};
const handleClose = () => {
setAnchorEl(null);
};
return (
<React.Fragment>
<Menu
anchorEl={anchorEl}
open={open}
onClose={handleClose}
aria-labelledby="with-menu-demo-breadcrumbs"
>
<MenuItem onClick={handleClose}>Breadcrumb 2</MenuItem>
<MenuItem onClick={handleClose}>Breadcrumb 3</MenuItem>
<MenuItem onClick={handleClose}>Breadcrumb 4</MenuItem>
</Menu>
<Breadcrumbs aria-label="breadcrumbs">
<Link color="primary" href="#condensed-with-menu">
Breadcrumb 1
</Link>
<Button size="sm" onClick={handleClick} variant="plain" color="primary">
•••
</Button>
<Link color="primary" href="#condensed-with-menu">
Breadcrumb 5
</Link>
<Link color="primary" href="#condensed-with-menu">
Breadcrumb 6
</Link>
</Breadcrumbs>
</React.Fragment>
);
}
| 860 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/BreadcrumbsWithMenu.tsx | import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Button from '@mui/joy/Button';
import Link from '@mui/joy/Link';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import * as React from 'react';
export default function BreadcrumbsWithMenu() {
const [anchorEl, setAnchorEl] = React.useState<HTMLButtonElement | null>(null);
const open = Boolean(anchorEl);
const handleClick = (event: React.MouseEvent<HTMLButtonElement> | null) => {
if (event) {
setAnchorEl(event.currentTarget);
}
};
const handleClose = () => {
setAnchorEl(null);
};
return (
<React.Fragment>
<Menu
anchorEl={anchorEl}
open={open}
onClose={handleClose}
aria-labelledby="with-menu-demo-breadcrumbs"
>
<MenuItem onClick={handleClose}>Breadcrumb 2</MenuItem>
<MenuItem onClick={handleClose}>Breadcrumb 3</MenuItem>
<MenuItem onClick={handleClose}>Breadcrumb 4</MenuItem>
</Menu>
<Breadcrumbs aria-label="breadcrumbs">
<Link color="primary" href="#condensed-with-menu">
Breadcrumb 1
</Link>
<Button size="sm" onClick={handleClick} variant="plain" color="primary">
•••
</Button>
<Link color="primary" href="#condensed-with-menu">
Breadcrumb 5
</Link>
<Link color="primary" href="#condensed-with-menu">
Breadcrumb 6
</Link>
</Breadcrumbs>
</React.Fragment>
);
}
| 861 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/CondensedBreadcrumbs.js | import FolderIcon from '@mui/icons-material/Folder';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Button from '@mui/joy/Button';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
import * as React from 'react';
export default function CondensedBreadcrumbs() {
const [condensed, setCondensed] = React.useState(true);
const [navigationItems, setNavigationItems] = React.useState([
'Programs',
'Files',
'Services',
]);
return (
<Breadcrumbs separator="›" aria-label="breadcrumbs">
{condensed ? (
<Button
size="sm"
onClick={() => {
setNavigationItems((prev) => ['Root', 'Home', ...prev]);
setCondensed(false);
}}
variant="plain"
color="primary"
>
•••
</Button>
) : null}
{navigationItems.map((item) => (
<Link key={item} color="primary" href="#condensed-breadcrumbs">
<FolderIcon sx={{ mr: 0.5 }} color="inherit" />
{item}
</Link>
))}
<Typography sx={{ display: 'flex', alignItems: 'center' }}>
<FolderIcon sx={{ mr: 0.5 }} />
bablo.txt
</Typography>
</Breadcrumbs>
);
}
| 862 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/CondensedBreadcrumbs.tsx | import FolderIcon from '@mui/icons-material/Folder';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Button from '@mui/joy/Button';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
import * as React from 'react';
export default function CondensedBreadcrumbs() {
const [condensed, setCondensed] = React.useState<boolean>(true);
const [navigationItems, setNavigationItems] = React.useState<string[]>([
'Programs',
'Files',
'Services',
]);
return (
<Breadcrumbs separator="›" aria-label="breadcrumbs">
{condensed ? (
<Button
size="sm"
onClick={() => {
setNavigationItems((prev) => ['Root', 'Home', ...prev]);
setCondensed(false);
}}
variant="plain"
color="primary"
>
•••
</Button>
) : null}
{navigationItems.map((item: string) => (
<Link key={item} color="primary" href="#condensed-breadcrumbs">
<FolderIcon sx={{ mr: 0.5 }} color="inherit" />
{item}
</Link>
))}
<Typography sx={{ display: 'flex', alignItems: 'center' }}>
<FolderIcon sx={{ mr: 0.5 }} />
bablo.txt
</Typography>
</Breadcrumbs>
);
}
| 863 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/SeparatorBreadcrumbs.js | import * as React from 'react';
import KeyboardArrowLeft from '@mui/icons-material/KeyboardArrowLeft';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
export default function SeparatorBreadcrumbs() {
return (
<Breadcrumbs separator={<KeyboardArrowLeft />} aria-label="breadcrumbs">
<Typography>Amy</Typography>
{['Characters', 'Futurama', 'TV Shows', 'Home'].map((item) => (
<Link key={item} color="neutral" href="#separators">
{item}
</Link>
))}
</Breadcrumbs>
);
}
| 864 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/SeparatorBreadcrumbs.tsx | import * as React from 'react';
import KeyboardArrowLeft from '@mui/icons-material/KeyboardArrowLeft';
import Breadcrumbs from '@mui/joy/Breadcrumbs';
import Link from '@mui/joy/Link';
import Typography from '@mui/joy/Typography';
export default function SeparatorBreadcrumbs() {
return (
<Breadcrumbs separator={<KeyboardArrowLeft />} aria-label="breadcrumbs">
<Typography>Amy</Typography>
{['Characters', 'Futurama', 'TV Shows', 'Home'].map((item: string) => (
<Link key={item} color="neutral" href="#separators">
{item}
</Link>
))}
</Breadcrumbs>
);
}
| 865 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/SeparatorBreadcrumbs.tsx.preview | <Breadcrumbs separator={<KeyboardArrowLeft />} aria-label="breadcrumbs">
<Typography>Amy</Typography>
{['Characters', 'Futurama', 'TV Shows', 'Home'].map((item: string) => (
<Link key={item} color="neutral" href="#separators">
{item}
</Link>
))}
</Breadcrumbs> | 866 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/breadcrumbs/breadcrumbs.md | ---
productId: joy-ui
title: React Breadcrumbs component
components: Breadcrumbs
githubLabel: 'component: breadcrumbs'
---
# Breadcrumbs
<p class="description">A breadcrumb trail is a navigational tool that helps users keep track of their location within an app.</p>
{{"component": "modules/components/ComponentLinkHeader.js"}}
## Introduction
The Breadcrumbs component consists of a list of links that show the user the hierarchy of a given page in relation to the app's structure.
It provides a simple visual aid for better context and ease of navigation between higher- and lower-level pages.
{{"demo": "BreadcrumbsUsage.js", "hideToolbar": true, "bg": "gradient"}}
## Basics
```jsx
import Breadcrumbs from '@mui/joy/Breadcrumbs';
```
The Breadcrumbs component acts as a wrapper for navigation links.
It's designed to be used with the [Link and Typography components](#usage-with-link-and-typography), as shown below:
{{"demo": "BasicBreadcrumbs.js"}}
## Customization
### Sizes
The Breadcrumbs component comes in three sizes: `sm`, `md` (default), and `lg`:
{{"demo": "BreadcrumbsSizes.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).
:::
### Separators
By default, the Breadcrumbs component inserts a forward slash (/) between each navigation item.
Use the `separator` prop to define a custom separator, which can be a character or a symbol as well as an icon:
{{"demo": "SeparatorBreadcrumbs.js"}}
## Usage with Link and Typography
```jsx
import Link from '@mui/joy/Link';
```
```jsx
import Typography from '@mui/joy/Typography';
```
The Breadcrumbs component doesn't accept common Joy UI style props like `variant`, `color`, `startDecorator`, or `endDecorator`—but [Link](/joy-ui/react-link/) and [Typography](/joy-ui/react-typography/) do.
As such, most custom styles that affect the content should be applied directly to those components rather than Breadcrumbs.
The demo below shows how to add an icon to the Link with `startDecorator` and change the color with the `color` prop:
{{"demo": "BreadcrumbsWithIcon.js"}}
## CSS variables playground
Play around with the CSS variables available to the Breadcrumbs component to see how the design changes.
You can use these to customize the component with both the `sx` prop and the theme.
{{"demo": "BreadcrumbsVariables.js", "hideToolbar": true, "bg": "gradient"}}
## Common examples
### Condensed Breadcrumbs
When the page hierarchy is deeply nested, you may want to condense multiple levels into one.
The demo below only displays a few previous levels until you click the ellipsis to show the full hierarchy:
{{"demo": "CondensedBreadcrumbs.js"}}
### Condensed with Menu
```jsx
import Menu from '@mui/joy/Menu';
```
As an alternative to the behavior of the condensed demo above, consider adding a [Menu](/joy-ui/react-menu/) component to display the condensed links in a dropdown list:
{{"demo": "BreadcrumbsWithMenu.js"}}
## Accessibility
(WAI-ARIA: https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/)
Be sure to add an informative `aria-label` description to the Breadcrumbs component.
The following features are included to optimize the component's baseline accessibility:
- The set of links is structured using an ordered list (`<ol>`).
- Visual separators between links are hidden with `aria-hidden` to prevent screen readers from announcing them.
- A `<nav>` element with an `aria-label` identifies the structure as a breadcrumb trail and makes it a navigation landmark so that it's easy to locate with assistive technology.
- The link to the current page has `aria-current` set to `page`.
## Anatomy
The Breadcrumbs component is composed of a root `<nav>` that wraps around an `<ol>`, with list items corresponding to the trail of links and their separators:
```html
<nav aria-label="breadcrumbs" class="MuiBreadcrumbs-root">
<ol class="MuiBreadcrumbs-ol">
<li class="MuiBreadcrumbs-li">
<!-- Link or Typography -->
</li>
<li aria-hidden="true" class="MuiBreadcrumbs-separator">/</li>
<li class="MuiBreadcrumbs-li css-1rqbcrs-MuiBreadcrumbs-ol">
<!-- Link or Typography -->
</li>
</ol>
</nav>
```
| 867 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/BasicButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function BasicButtonGroup() {
return (
<ButtonGroup aria-label="outlined primary button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 868 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/BasicButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function BasicButtonGroup() {
return (
<ButtonGroup aria-label="outlined primary button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 869 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/BasicButtonGroup.tsx.preview | <ButtonGroup aria-label="outlined primary button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup> | 870 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/ButtonGroupColors.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Stack from '@mui/joy/Stack';
export default function ButtonGroupColors() {
const [variant, setVariant] = React.useState('outlined');
const createOnClick = (value) => () => {
setVariant(value);
};
return (
<Stack spacing={1} alignItems="center">
<ButtonGroup variant={variant} size="sm" aria-label="neutral button group">
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="primary"
aria-label="primary button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="danger"
aria-label="danger button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="success"
aria-label="success button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="warning"
aria-label="warning button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
</Stack>
);
}
| 871 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/ButtonGroupColors.tsx | import * as React from 'react';
import { VariantProp } from '@mui/joy/styles';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Stack from '@mui/joy/Stack';
export default function ButtonGroupColors() {
const [variant, setVariant] = React.useState<VariantProp>('outlined');
const createOnClick = (value: VariantProp) => () => {
setVariant(value);
};
return (
<Stack spacing={1} alignItems="center">
<ButtonGroup variant={variant} size="sm" aria-label="neutral button group">
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="primary"
aria-label="primary button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="danger"
aria-label="danger button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="success"
aria-label="success button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
<ButtonGroup
variant={variant}
size="sm"
color="warning"
aria-label="warning button group"
>
<Button onClick={createOnClick('outlined')}>Outlined</Button>
<Button onClick={createOnClick('plain')}>Plain</Button>
<Button onClick={createOnClick('soft')}>Soft</Button>
<Button onClick={createOnClick('solid')}>Solid</Button>
</ButtonGroup>
</Stack>
);
}
| 872 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/ButtonGroupUsage.js | import * as React from 'react';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Button from '@mui/joy/Button';
import IconButton from '@mui/joy/IconButton';
import FavoriteBorder from '@mui/icons-material/FavoriteBorder';
import JoyUsageDemo from 'docs/src/modules/components/JoyUsageDemo';
export default function ButtonGroupUsage() {
return (
<JoyUsageDemo
componentName="ButtonGroup"
data={[
{
propName: 'variant',
knob: 'radio',
defaultValue: 'outlined',
options: ['plain', 'outlined', 'soft', 'solid'],
},
{
propName: 'color',
knob: 'color',
defaultValue: 'neutral',
},
{
propName: 'disabled',
knob: 'switch',
},
{
propName: 'size',
knob: 'radio',
options: ['sm', 'md', 'lg'],
defaultValue: 'md',
},
{
propName: 'orientation',
knob: 'radio',
defaultValue: 'horizontal',
options: ['horizontal', 'vertical'],
},
{
propName: 'spacing',
knob: 'number',
defaultValue: 0,
},
{
propName: 'children',
defaultValue: `<Button />
...
<IconButton />`,
},
]}
renderDemo={(props) => (
<ButtonGroup {...props}>
<Button>Vote</Button>
<Button>Comment</Button>
<IconButton>
<FavoriteBorder />
</IconButton>
</ButtonGroup>
)}
/>
);
}
| 873 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/CustomSeparatorButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Divider from '@mui/joy/Divider';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function CustomSeparatorButtonGroup() {
return (
<ButtonGroup
variant="solid"
color="success"
aria-label="button group"
sx={{
'--ButtonGroup-separatorColor': 'none !important',
'& > span': {
zIndex: 3,
background:
'linear-gradient(to top, transparent, rgba(255 255 255 / 0.6), transparent)',
},
}}
>
<Button>One</Button>
<Divider />
<Button>Two</Button>
<Divider />
<Button>Three</Button>
<Divider />
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 874 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/CustomSeparatorButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Divider from '@mui/joy/Divider';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function CustomSeparatorButtonGroup() {
return (
<ButtonGroup
variant="solid"
color="success"
aria-label="button group"
sx={{
'--ButtonGroup-separatorColor': 'none !important',
'& > span': {
zIndex: 3,
background:
'linear-gradient(to top, transparent, rgba(255 255 255 / 0.6), transparent)',
},
}}
>
<Button>One</Button>
<Divider />
<Button>Two</Button>
<Divider />
<Button>Three</Button>
<Divider />
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 875 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/DisabledButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function DisabledButtonGroup() {
return (
<ButtonGroup disabled aria-label="disabled button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton disabled={false}>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 876 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/DisabledButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function DisabledButtonGroup() {
return (
<ButtonGroup disabled aria-label="disabled button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton disabled={false}>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 877 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/DisabledButtonGroup.tsx.preview | <ButtonGroup disabled aria-label="disabled button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton disabled={false}>
<Settings />
</IconButton>
</ButtonGroup> | 878 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/FlexButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function FlexButtonGroup() {
return (
<ButtonGroup
buttonFlex={1}
aria-label="flex button group"
sx={{
p: 2,
width: 500,
maxWidth: '100%',
overflow: 'auto',
resize: 'horizontal',
}}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 879 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/FlexButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function FlexButtonGroup() {
return (
<ButtonGroup
buttonFlex={1}
aria-label="flex button group"
sx={{
p: 2,
width: 500,
maxWidth: '100%',
overflow: 'auto',
resize: 'horizontal',
}}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 880 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/GroupOrientation.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Stack from '@mui/joy/Stack';
const buttons = [
<Button key="one">One</Button>,
<Button key="two" disabled>
Two
</Button>,
<Button key="three">Three</Button>,
];
export default function GroupOrientation() {
return (
<Stack spacing={2} direction="row">
<ButtonGroup
orientation="vertical"
aria-label="vertical outlined button group"
>
{buttons}
</ButtonGroup>
<ButtonGroup
orientation="vertical"
aria-label="vertical plain button group"
variant="plain"
>
{buttons}
</ButtonGroup>
<ButtonGroup
orientation="vertical"
aria-label="vertical soft button group"
variant="soft"
>
{buttons}
</ButtonGroup>
<ButtonGroup
orientation="vertical"
aria-label="vertical solid button group"
variant="solid"
>
{buttons}
</ButtonGroup>
</Stack>
);
}
| 881 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/GroupOrientation.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Stack from '@mui/joy/Stack';
const buttons = [
<Button key="one">One</Button>,
<Button key="two" disabled>
Two
</Button>,
<Button key="three">Three</Button>,
];
export default function GroupOrientation() {
return (
<Stack spacing={2} direction="row">
<ButtonGroup
orientation="vertical"
aria-label="vertical outlined button group"
>
{buttons}
</ButtonGroup>
<ButtonGroup
orientation="vertical"
aria-label="vertical plain button group"
variant="plain"
>
{buttons}
</ButtonGroup>
<ButtonGroup
orientation="vertical"
aria-label="vertical soft button group"
variant="soft"
>
{buttons}
</ButtonGroup>
<ButtonGroup
orientation="vertical"
aria-label="vertical solid button group"
variant="solid"
>
{buttons}
</ButtonGroup>
</Stack>
);
}
| 882 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/GroupSizesColors.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Stack from '@mui/joy/Stack';
export default function GroupSizesColors() {
return (
<Stack spacing={2} alignItems="center">
<ButtonGroup size="sm" aria-label="outlined button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
<ButtonGroup aria-label="plain button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
<ButtonGroup size="lg" aria-label="soft button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
</Stack>
);
}
| 883 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/GroupSizesColors.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Stack from '@mui/joy/Stack';
export default function GroupSizesColors() {
return (
<Stack spacing={2} alignItems="center">
<ButtonGroup size="sm" aria-label="outlined button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
<ButtonGroup aria-label="plain button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
<ButtonGroup size="lg" aria-label="soft button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
</Stack>
);
}
| 884 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/GroupSizesColors.tsx.preview | <ButtonGroup size="sm" aria-label="outlined button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
<ButtonGroup aria-label="plain button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
<ButtonGroup size="lg" aria-label="soft button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup> | 885 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/MinWidthButtonGroup.js | import * as React from 'react';
import Card from '@mui/joy/Card';
import CardContent from '@mui/joy/CardContent';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Typography from '@mui/joy/Typography';
export default function MinWidthButtonGroup() {
return (
<Card
variant="outlined"
sx={{
width: '100%',
overflow: 'auto',
resize: 'horizontal',
}}
>
<CardContent sx={{ textAlign: 'center', alignItems: 'center' }}>
<Typography fontSize="lg" fontWeight="lg">
Title
</Typography>
<Typography mb={3} maxWidth="32ch">
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
</Typography>
<ButtonGroup
variant="soft"
aria-label="outlined primary button group"
buttonFlex="0 1 200px"
sx={{ width: '100%', justifyContent: 'center' }}
>
<Button>Buy</Button>
<Button>Learn</Button>
</ButtonGroup>
</CardContent>
</Card>
);
}
| 886 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/MinWidthButtonGroup.tsx | import * as React from 'react';
import Card from '@mui/joy/Card';
import CardContent from '@mui/joy/CardContent';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Typography from '@mui/joy/Typography';
export default function MinWidthButtonGroup() {
return (
<Card
variant="outlined"
sx={{
width: '100%',
overflow: 'auto',
resize: 'horizontal',
}}
>
<CardContent sx={{ textAlign: 'center', alignItems: 'center' }}>
<Typography fontSize="lg" fontWeight="lg">
Title
</Typography>
<Typography mb={3} maxWidth="32ch">
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
</Typography>
<ButtonGroup
variant="soft"
aria-label="outlined primary button group"
buttonFlex="0 1 200px"
sx={{ width: '100%', justifyContent: 'center' }}
>
<Button>Buy</Button>
<Button>Learn</Button>
</ButtonGroup>
</CardContent>
</Card>
);
}
| 887 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/RadiusButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function RadiusButtonGroup() {
return (
<ButtonGroup
aria-label="radius button group"
sx={{ '--ButtonGroup-radius': '40px' }}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 888 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/RadiusButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function RadiusButtonGroup() {
return (
<ButtonGroup
aria-label="radius button group"
sx={{ '--ButtonGroup-radius': '40px' }}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 889 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/RadiusButtonGroup.tsx.preview | <ButtonGroup
aria-label="radius button group"
sx={{ '--ButtonGroup-radius': '40px' }}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup> | 890 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SeparatorButtonGroup.js | import * as React from 'react';
import Box from '@mui/joy/Box';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Slider from '@mui/joy/Slider';
import Settings from '@mui/icons-material/Settings';
export default function SeparatorButtonGroup() {
const [hue, setHue] = React.useState(0);
return (
<Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
<Slider
value={hue}
min={0}
max={360}
valueLabelDisplay="on"
valueLabelFormat={(value) => `hsl(${value} 100% 50%)`}
onChange={(event, newValue) => setHue(newValue)}
/>
<ButtonGroup
variant="plain"
aria-label="button group"
sx={{ '--ButtonGroup-separatorColor': `hsl(${hue} 100% 50%) !important` }}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
</Box>
);
}
| 891 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SeparatorButtonGroup.tsx | import * as React from 'react';
import Box from '@mui/joy/Box';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Slider from '@mui/joy/Slider';
import Settings from '@mui/icons-material/Settings';
export default function SeparatorButtonGroup() {
const [hue, setHue] = React.useState(0);
return (
<Box sx={{ display: 'flex', flexDirection: 'column', gap: 2 }}>
<Slider
value={hue}
min={0}
max={360}
valueLabelDisplay="on"
valueLabelFormat={(value) => `hsl(${value} 100% 50%)`}
onChange={(event, newValue) => setHue(newValue as number)}
/>
<ButtonGroup
variant="plain"
aria-label="button group"
sx={{ '--ButtonGroup-separatorColor': `hsl(${hue} 100% 50%) !important` }}
>
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
</Box>
);
}
| 892 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SpacingButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function SpacingButtonGroup() {
return (
<ButtonGroup spacing="0.5rem" aria-label="spacing button group">
<Button>One</Button>
<Button disabled>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 893 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SpacingButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Settings from '@mui/icons-material/Settings';
export default function SpacingButtonGroup() {
return (
<ButtonGroup spacing="0.5rem" aria-label="spacing button group">
<Button>One</Button>
<Button disabled>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup>
);
}
| 894 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SpacingButtonGroup.tsx.preview | <ButtonGroup spacing="0.5rem" aria-label="spacing button group">
<Button>One</Button>
<Button disabled>Two</Button>
<Button>Three</Button>
<IconButton>
<Settings />
</IconButton>
</ButtonGroup> | 895 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SplitButton.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import IconButton from '@mui/joy/IconButton';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ArrowDropDownIcon from '@mui/icons-material/ArrowDropDown';
const options = ['Create a merge commit', 'Squash and merge', 'Rebase and merge'];
export default function SplitButton() {
const [open, setOpen] = React.useState(false);
const actionRef = React.useRef(null);
const anchorRef = React.useRef(null);
const [selectedIndex, setSelectedIndex] = React.useState(1);
const handleClick = () => {
console.info(`You clicked ${options[selectedIndex]}`);
};
const handleMenuItemClick = (event, index) => {
setSelectedIndex(index);
setOpen(false);
};
return (
<React.Fragment>
<ButtonGroup
ref={anchorRef}
variant="solid"
color="success"
aria-label="split button"
>
<Button onClick={handleClick}>{options[selectedIndex]}</Button>
<IconButton
aria-controls={open ? 'split-button-menu' : undefined}
aria-expanded={open ? 'true' : undefined}
aria-label="select merge strategy"
aria-haspopup="menu"
onMouseDown={() => {
actionRef.current = () => setOpen(!open);
}}
onKeyDown={() => {
actionRef.current = () => setOpen(!open);
}}
onClick={() => {
actionRef.current?.();
}}
>
<ArrowDropDownIcon />
</IconButton>
</ButtonGroup>
<Menu open={open} onClose={() => setOpen(false)} anchorEl={anchorRef.current}>
{options.map((option, index) => (
<MenuItem
key={option}
disabled={index === 2}
selected={index === selectedIndex}
onClick={(event) => handleMenuItemClick(event, index)}
>
{option}
</MenuItem>
))}
</Menu>
</React.Fragment>
);
}
| 896 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/SplitButton.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import IconButton from '@mui/joy/IconButton';
import ButtonGroup from '@mui/joy/ButtonGroup';
import Menu from '@mui/joy/Menu';
import MenuItem from '@mui/joy/MenuItem';
import ArrowDropDownIcon from '@mui/icons-material/ArrowDropDown';
const options = ['Create a merge commit', 'Squash and merge', 'Rebase and merge'];
export default function SplitButton() {
const [open, setOpen] = React.useState(false);
const actionRef = React.useRef<() => void | null>(null);
const anchorRef = React.useRef<HTMLDivElement>(null);
const [selectedIndex, setSelectedIndex] = React.useState(1);
const handleClick = () => {
console.info(`You clicked ${options[selectedIndex]}`);
};
const handleMenuItemClick = (
event: React.MouseEvent<HTMLElement, MouseEvent>,
index: number,
) => {
setSelectedIndex(index);
setOpen(false);
};
return (
<React.Fragment>
<ButtonGroup
ref={anchorRef}
variant="solid"
color="success"
aria-label="split button"
>
<Button onClick={handleClick}>{options[selectedIndex]}</Button>
<IconButton
aria-controls={open ? 'split-button-menu' : undefined}
aria-expanded={open ? 'true' : undefined}
aria-label="select merge strategy"
aria-haspopup="menu"
onMouseDown={() => {
// @ts-ignore
actionRef.current = () => setOpen(!open);
}}
onKeyDown={() => {
// @ts-ignore
actionRef.current = () => setOpen(!open);
}}
onClick={() => {
actionRef.current?.();
}}
>
<ArrowDropDownIcon />
</IconButton>
</ButtonGroup>
<Menu open={open} onClose={() => setOpen(false)} anchorEl={anchorRef.current}>
{options.map((option, index) => (
<MenuItem
key={option}
disabled={index === 2}
selected={index === selectedIndex}
onClick={(event) => handleMenuItemClick(event, index)}
>
{option}
</MenuItem>
))}
</Menu>
</React.Fragment>
);
}
| 897 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/TooltipButtonGroup.js | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Tooltip from '@mui/joy/Tooltip';
import Settings from '@mui/icons-material/Settings';
import Person from '@mui/icons-material/Person';
export default function TooltipButtonGroup() {
return (
<ButtonGroup variant="soft" aria-label="tooltip button group">
<Tooltip arrow title="Go to profile">
<Button startDecorator={<Person />}>Hover me</Button>
</Tooltip>
<Tooltip arrow title="Open settings">
<span>
<IconButton disabled>
<Settings />
</IconButton>
</span>
</Tooltip>
<Tooltip arrow title="Go to profile">
<Button endDecorator={<Person />}>Hover me</Button>
</Tooltip>
</ButtonGroup>
);
}
| 898 |
0 | petrpan-code/mui/material-ui/docs/data/joy/components | petrpan-code/mui/material-ui/docs/data/joy/components/button-group/TooltipButtonGroup.tsx | import * as React from 'react';
import Button from '@mui/joy/Button';
import ButtonGroup from '@mui/joy/ButtonGroup';
import IconButton from '@mui/joy/IconButton';
import Tooltip from '@mui/joy/Tooltip';
import Settings from '@mui/icons-material/Settings';
import Person from '@mui/icons-material/Person';
export default function TooltipButtonGroup() {
return (
<ButtonGroup variant="soft" aria-label="tooltip button group">
<Tooltip arrow title="Go to profile">
<Button startDecorator={<Person />}>Hover me</Button>
</Tooltip>
<Tooltip arrow title="Open settings">
<span>
<IconButton disabled>
<Settings />
</IconButton>
</span>
</Tooltip>
<Tooltip arrow title="Go to profile">
<Button endDecorator={<Person />}>Hover me</Button>
</Tooltip>
</ButtonGroup>
);
}
| 899 |
Subsets and Splits