跳转到内容
编辑此页面

Button API

想要学习更多组件属性和 CSS API，可以查阅 React Button 组件的 API 文档。

导入

import Button from '@mui/material/Button';
// 或
import { Button } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

组件名称

The name MuiButton can be used when providing default props or style overrides in the theme.

属性

ButtonBase 组件的属性也是可用的。

名称类型默认值描述
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'error'
| 'info'
| '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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalse
如果被设置为 true，那么该组件将会被禁用。
disableElevationboolfalse
If true, no elevation is used.
disableFocusRippleboolfalse
If true, the keyboard focus ripple is disabled.
disableRippleboolfalse
If true, the ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName.
endIconnode
Element placed after the children.
fullWidthboolfalse
If true, the button will take up the full width of its container.
hrefstring
The URL to link to when the button is clicked. If defined, an a element will be used as the root node.
size'small'
| 'medium'
| 'large'
| string		'medium'
The size of the button. small is equivalent to the dense button styling.
startIconnode
Element placed before the children.
sxArray<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		'text'
The variant to use.

ref 则会被传递到根元素中。

继承

While not explicitly documented above, the props of the ButtonBase component are also available on Button. You can take advantage of this to target nested components.

CSS

规则名称全局类名描述
root.MuiButton-rootStyles applied to the root element.
text.MuiButton-textStyles applied to the root element if variant="text".
textInherit.MuiButton-textInheritStyles applied to the root element if variant="text" and color="inherit".
textPrimary.MuiButton-textPrimaryStyles applied to the root element if variant="text" and color="primary".
textSecondary.MuiButton-textSecondaryStyles applied to the root element if variant="text" and color="secondary".
textSuccess.MuiButton-textSuccess
textError.MuiButton-textError
textInfo.MuiButton-textInfo
textWarning.MuiButton-textWarning
outlined.MuiButton-outlinedStyles applied to the root element if variant="outlined".
outlinedInherit.MuiButton-outlinedInheritStyles applied to the root element if variant="outlined" and color="inherit".
outlinedPrimary.MuiButton-outlinedPrimaryStyles applied to the root element if variant="outlined" and color="primary".
outlinedSecondary.MuiButton-outlinedSecondaryStyles applied to the root element if variant="outlined" and color="secondary".
outlinedSuccess.MuiButton-outlinedSuccess
outlinedError.MuiButton-outlinedError
outlinedInfo.MuiButton-outlinedInfo
outlinedWarning.MuiButton-outlinedWarning
contained.MuiButton-containedStyles applied to the root element if variant="contained".
containedInherit.MuiButton-containedInheritStyles applied to the root element if variant="contained" and color="inherit".
containedPrimary.MuiButton-containedPrimaryStyles applied to the root element if variant="contained" and color="primary".
containedSecondary.MuiButton-containedSecondaryStyles applied to the root element if variant="contained" and color="secondary".
containedSuccess.MuiButton-containedSuccess
containedInfo.MuiButton-containedInfo
containedError.MuiButton-containedError
containedWarning.MuiButton-containedWarning
disableElevation.MuiButton-disableElevationStyles applied to the root element if disableElevation={true}.
focusVisible.Mui-focusVisiblePseudo-class applied to the ButtonBase root element if the button is keyboard focused.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
colorInherit.MuiButton-colorInheritStyles applied to the root element if color="inherit".
textSizeSmall.MuiButton-textSizeSmallStyles applied to the root element if size="small" and variant="text".
textSizeMedium.MuiButton-textSizeMediumStyles applied to the root element if size="medium" and variant="text".
textSizeLarge.MuiButton-textSizeLargeStyles applied to the root element if size="large" and variant="text".
outlinedSizeSmall.MuiButton-outlinedSizeSmallStyles applied to the root element if size="small" and variant="outlined".
outlinedSizeMedium.MuiButton-outlinedSizeMediumStyles applied to the root element if size="medium" and variant="outlined".
outlinedSizeLarge.MuiButton-outlinedSizeLargeStyles applied to the root element if size="large" and variant="outlined".
containedSizeSmall.MuiButton-containedSizeSmallStyles applied to the root element if size="small" and variant="contained".
containedSizeMedium.MuiButton-containedSizeMediumStyles applied to the root element if size="small" and variant="contained".
containedSizeLarge.MuiButton-containedSizeLargeStyles applied to the root element if size="large" and variant="contained".
sizeSmall.MuiButton-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiButton-sizeMediumStyles applied to the root element if size="medium".
sizeLarge.MuiButton-sizeLargeStyles applied to the root element if size="large".
fullWidth.MuiButton-fullWidthStyles applied to the root element if fullWidth={true}.
startIcon.MuiButton-startIconStyles applied to the startIcon element if supplied.
endIcon.MuiButton-endIconStyles applied to the endIcon element if supplied.
iconSizeSmall.MuiButton-iconSizeSmallStyles applied to the icon element if supplied and size="small".
iconSizeMedium.MuiButton-iconSizeMediumStyles applied to the icon element if supplied and size="medium".
iconSizeLarge.MuiButton-iconSizeLargeStyles applied to the icon element if supplied and size="large".

您可以使用组件自定义选项对组件进行个性化：

演示项目