React Button component - Material UI (original) (raw)

+

Buttons allow users to take actions, and make choices, with a single tap.

Buttons communicate actions that users can take. They are typically placed throughout your UI, in places like:

• Modal windows

• Forms

• Cards

• Toolbars

• Feedback

• Bundle size

• WAI-ARIA

• Material Design

• Figma

• Adobe

• Sketch

Basic button

The Button comes with three variants: text (default), contained, and outlined.

Press Enter to start editing

Text button

Text buttonsare typically used for less-pronounced actions, including those located: in dialogs, in cards. In cards, text buttons help maintain an emphasis on card content.

Press Enter to start editing

Contained button

Contained buttonsare high-emphasis, distinguished by their use of elevation and fill. They contain actions that are primary to your app.

Press Enter to start editing

You can remove the elevation with the disableElevation prop.

Press Enter to start editing

Outlined button

Outlined buttons are medium-emphasis buttons. They contain actions that are important but aren't the primary action in an app.

Outlined buttons are also a lower emphasis alternative to contained buttons, or a higher emphasis alternative to text buttons.

Press Enter to start editing

Handling clicks

All components accept an onClick handler that is applied to the root DOM element.

<Button
  onClick={() => {
    alert('clicked');
  }}
>
  Click me
</Button>

Note that the documentation avoids mentioning native props (there are a lot) in the API section of the components.

Color

Press Enter to start editing

In addition to using the default button colors, you can add custom ones, or disable any you don't need. See the Adding new colors examples for more info.

Sizes

For larger or smaller buttons, use the size prop.

Buttons with icons and label

Sometimes you might want to have icons for certain buttons to enhance the UX of the application as we recognize logos more easily than plain text. For example, if you have a delete button you can label it with a dustbin icon.

Press Enter to start editing

Icon button

Icon buttons are commonly found in app bars and toolbars.

Icons are also appropriate for toggle buttons that allow a single choice to be selected or deselected, such as adding or removing a star to an item.

Press Enter to start editing

Sizes

For larger or smaller icon buttons, use the size prop.

Press Enter to start editing

Colors

Use color prop to apply theme color palette to component.

Press Enter to start editing

File upload

To create a file upload button, turn the button into a label using component="label" and then create a visually-hidden input with type file.

Upload file

Press Enter to start editing

Customization

Here are some examples of customizing the component. You can learn more about this in the overrides documentation page.

🎨 If you are looking for inspiration, you can check MUI Treasury's customization examples.

Complex button

The Text Buttons, Contained Buttons, Floating Action Buttons and Icon Buttons are built on top of the same component: the ButtonBase. You can take advantage of this lower-level component to build custom interactions.

Third-party routing library

One frequent use case is to perform navigation on the client only, without an HTTP round-trip to the server. The ButtonBase component provides the component prop to handle this use case. Here is a more detailed guide.

Limitations

Cursor not-allowed

The ButtonBase component sets pointer-events: none; on disabled buttons, which prevents the appearance of a disabled cursor.

If you wish to use not-allowed, you have two options:

1. CSS only. You can remove the pointer-events style on the disabled state of the <button> element:

.MuiButtonBase-root:disabled {
  cursor: not-allowed;
  pointer-events: auto;
}

However:

• You should add pointer-events: none; back when you need to display tooltips on disabled elements.
• The cursor won't change if you render something other than a button element, for instance, a link <a> element.

1. DOM change. You can wrap the button:

<span style={{ cursor: 'not-allowed' }}>
  <Button component={Link} disabled>
    disabled
  </Button>
</span>

This has the advantage of supporting any element, for instance, a link <a> element.

Experimental APIs

Loading button

@mui/lab offers loading buttons that can show loading state and disable interactions.

Press Enter to start editing

Toggle the loading switch to see the transition between the different states.

Unstyled

Use the Base UI Button for complete ownership of the component's design, with no Material UI or Joy UI styles to override. This unstyled version of the component is the ideal choice for heavy customization with a smaller bundle size.

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.