ButtonBase API
API reference docs for the React ButtonBase component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import ButtonBase from '@mui/material/ButtonBase';
// or
import { ButtonBase } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
ButtonBase
contains as few styles as possible.
It aims to be a simple building block for creating a button.
It contains a load of style reset and some focus/ripple logic.
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
action | ref | - | A ref for imperative actions. It currently only supports |
centerRipple | bool | false | If |
children | node | - | The content of the component. |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
component | element type | - | The component used for the root node. Either a string to use a HTML element or a component. |
disabled | bool | false | If |
disableRipple | bool | false | If |
disableTouchRipple | bool | false | If |
focusRipple | bool | false | If |
focusVisibleClassName | string | - | This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a |
LinkComponent | elementType | 'a' | The component used to render a link when the |
onFocusVisible | func | - | Callback fired when the component is focused with a keyboard. We trigger a |
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. |
TouchRippleProps | object | - | Props applied to the |
touchRippleRef | func | { current?: { pulsate: func, start: func, stop: func } } | - | A ref that points to the |
ref
is forwarded to the root element.Theme default props
You can use MuiButtonBase
to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.Mui-disabled | State class applied to the root element if disabled={true} . | |
.Mui-focusVisible | State class applied to the root element if keyboard focused. | |
.MuiButtonBase-root | root | Styles applied to the root element. |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.