Skip to content

ButtonBase API

API documentation for the React ButtonBase component. Learn about the available props and the CSS API.

Import

import ButtonBase from '@mui/material/ButtonBase';
// or
import { ButtonBase } from '@mui/material';
You can 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.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
actionref
A ref for imperative actions. It currently only supports focusVisible() action.
centerRippleboolfalse
If true, the ripples are centered. They won't start at the cursor interaction position.
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelement type
The component used for the root node. Either a string to use a HTML element or a component.
⚠️ Needs to be able to hold a ref.
disabledboolfalse
If true, the component 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 .Mui-focusVisible class.
disableTouchRippleboolfalse
If true, the touch ripple effect is disabled.
focusRippleboolfalse
If true, the base button will have a keyboard focus ripple.
focusVisibleClassNamestring
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 focus-visible class to other components if needed.
LinkComponentelementType'a'
The component used to render a link when the href prop is provided.
onFocusVisiblefunc
Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.
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.
TouchRipplePropsobject
Props applied to the TouchRipple element.
touchRippleReffunc
| { current?: { pulsate: func, start: func, stop: func } }
A ref that points to the TouchRipple element.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiButtonBase-rootStyles applied to the root element.
disabled.Mui-disabledState class applied to the root element if disabled={true}.
focusVisible.Mui-focusVisibleState class applied to the root element if keyboard focused.

You can override the style of the component using one of these customization options:

Demos