Skip to content
Edit this page

ButtonBase API

API reference docs for the React ButtonBase component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

Props of the native component are also available.

action

A ref for imperative actions. It currently only supports focusVisible() action.

Type:

ref
centerRipple

If true, the ripples are centered. They won't start at the cursor interaction position.

Type:

bool

Default:

false
children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

element type
disabled

If true, the component is disabled.

Type:

bool

Default:

false
disableRipple

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.

Type:

bool

Default:

false
disableTouchRipple

If true, the touch ripple effect is disabled.

Type:

bool

Default:

false
focusRipple

If true, the base button will have a keyboard focus ripple.

Type:

bool

Default:

false
focusVisibleClassName

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.

Type:

string
LinkComponent

The component used to render a link when the href prop is provided.

Type:

elementType

Default:

'a'
onFocusVisible

Callback fired when the component is focused with a keyboard. We trigger a onFocus callback too.

Type:

func
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
TouchRippleProps

Props applied to the TouchRipple element.

Type:

object
touchRippleRef

A ref that points to the TouchRipple element.

Type:

func | { current?: { pulsate: func, start: func, stop: func } }
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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiButtonBase-rootroot

Styles applied to the root element.

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.Mui-focusVisiblefocusVisibleSTATE

State class applied to the root element if keyboard focused.

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