ButtonGroup API
导入
import ButtonGroup from '@mui/material/ButtonGroup';
// 或
import { ButtonGroup } from '@mui/material';
组件名称
在主题中,名称“MuiButtonGroup
”可用于提供默认属性(props),或者样式覆盖属性
原生(Native) 组件的属性也是可用的。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
children | node | The content of the component. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
color | 'inherit' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
disabled | bool | false | 如果被设置为 true ,那么该组件将会被禁用。 |
disableElevation | bool | false | If true , no elevation is used. |
disableFocusRipple | bool | false | If true , the button keyboard focus ripple is disabled. |
disableRipple | bool | false | If true , the button ripple effect is disabled. |
fullWidth | bool | false | If true , the buttons will take up the full width of its container. |
orientation | 'horizontal' | 'vertical' | 'horizontal' | The group orientation (layout flow direction). |
size | 'small' | 'medium' | 'large' | string | 'medium' | The size of the button. small is equivalent to the dense button styling. |
sx | Array<func | object | bool> | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. | |
variant | 'contained' | 'outlined' | 'text' | string | 'outlined' | The variant to use. |
ref
则会被传递到根元素中。CSS
规则名称 | 全局类名 | 描述 |
---|---|---|
root | .MuiButtonGroup-root | Styles applied to the root element. |
contained | .MuiButtonGroup-contained | Styles applied to the root element if variant="contained" . |
outlined | .MuiButtonGroup-outlined | Styles applied to the root element if variant="outlined" . |
text | .MuiButtonGroup-text | Styles applied to the root element if variant="text" . |
disableElevation | .MuiButtonGroup-disableElevation | Styles applied to the root element if disableElevation={true} . |
disabled | .Mui-disabled | Pseudo-class applied to the child elements if disabled={true} . |
fullWidth | .MuiButtonGroup-fullWidth | Styles applied to the root element if fullWidth={true} . |
vertical | .MuiButtonGroup-vertical | Styles applied to the root element if orientation="vertical" . |
grouped | .MuiButtonGroup-grouped | Styles applied to the children. |
groupedHorizontal | .MuiButtonGroup-groupedHorizontal | Styles applied to the children if orientation="horizontal" . |
groupedVertical | .MuiButtonGroup-groupedVertical | Styles applied to the children if orientation="vertical" . |
groupedText | .MuiButtonGroup-groupedText | Styles applied to the children if variant="text" . |
groupedTextHorizontal | .MuiButtonGroup-groupedTextHorizontal | Styles applied to the children if variant="text" and orientation="horizontal" . |
groupedTextVertical | .MuiButtonGroup-groupedTextVertical | Styles applied to the children if variant="text" and orientation="vertical" . |
groupedTextPrimary | .MuiButtonGroup-groupedTextPrimary | Styles applied to the children if variant="text" and color="primary" . |
groupedTextSecondary | .MuiButtonGroup-groupedTextSecondary | Styles applied to the children if variant="text" and color="secondary" . |
groupedOutlined | .MuiButtonGroup-groupedOutlined | Styles applied to the children if variant="outlined" . |
groupedOutlinedHorizontal | .MuiButtonGroup-groupedOutlinedHorizontal | Styles applied to the children if variant="outlined" and orientation="horizontal" . |
groupedOutlinedVertical | .MuiButtonGroup-groupedOutlinedVertical | Styles applied to the children if variant="outlined" and orientation="vertical" . |
groupedOutlinedPrimary | .MuiButtonGroup-groupedOutlinedPrimary | Styles applied to the children if variant="outlined" and color="primary" . |
groupedOutlinedSecondary | .MuiButtonGroup-groupedOutlinedSecondary | Styles applied to the children if variant="outlined" and color="secondary" . |
groupedContained | .MuiButtonGroup-groupedContained | Styles applied to the children if variant="contained" . |
groupedContainedHorizontal | .MuiButtonGroup-groupedContainedHorizontal | Styles applied to the children if variant="contained" and orientation="horizontal" . |
groupedContainedVertical | .MuiButtonGroup-groupedContainedVertical | Styles applied to the children if variant="contained" and orientation="vertical" . |
groupedContainedPrimary | .MuiButtonGroup-groupedContainedPrimary | Styles applied to the children if variant="contained" and color="primary" . |
groupedContainedSecondary | .MuiButtonGroup-groupedContainedSecondary | Styles applied to the children if variant="contained" and color="secondary" . |
您可以使用组件自定义选项对组件进行个性化:
- 具备 全局类名.
- 在自定义主体中,设定一个规则名称作为组件的
styleOverrides
属性的一部分。