Saltar al contenido

ButtonBase API

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

Import

import ButtonBase from '@material-ui/core/ButtonBase';
// or
import { ButtonBase } from '@material-ui/core';
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

NameTypeDefaultDescription
actionrefA ref for imperative actions. It currently only supports focusVisible() action.
centerRippleboolfalseIf true, the ripples are centered. They won't start at the cursor interaction position.
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelement typeThe 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.
disabledboolfalseIf true, the base button is disabled.
disableRippleboolfalseIf 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.
disableTouchRippleboolfalseIf true, the touch ripple effect is disabled.
focusRippleboolfalseIf true, the base button will have a keyboard focus ripple.
focusVisibleClassNamestringThis prop can help a person know which element has the keyboard focus. The class name will be applied when the element gain the focus through a 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.
onFocusVisiblefuncCallback fired when the component is focused with a keyboard. We trigger a onFocus callback too.
TouchRipplePropsobjectProps applied to the TouchRipple element.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

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

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos