Button

import { ButtonDemos, StylesDemos, ThemingDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.Button);

Usage

Full width

If the fullWidth prop is set, the Button will take 100% of the parent width:

Left and right sections

leftSection and rightSection allow adding icons or any other element to the left and right sides of the button. When a section is added, padding on the corresponding side is reduced.

Note that leftSection and rightSection are flipped in RTL mode (leftSection is displayed on the right and rightSection is displayed on the left).

Sections position

The justify prop sets the justify-content of the inner element. You can use it to change the alignment of left and right sections. For example, to spread them across the button, set justify="space-between".

If you need to align just one section to the side of the button, set justify to space-between and add an empty <span /> to the opposite section.

Compact size

Button supports xs – xl and compact-xs – compact-xl sizes. compact sizes have the same font size as xs – xl but with reduced padding and height.

Disabled state

To make a Button disabled, set the disabled prop. This will prevent any interactions with the button and add disabled styles. If you want the button to just look disabled but still be interactive, set the data-disabled prop instead. Note that disabled styles are the same for all variants.

Disabled state when Button is link

The <a /> element does not support the disabled attribute. To make a Button disabled when it is rendered as a link, set the data-disabled attribute instead and prevent default behavior in the onClick event handler.

Customize disabled styles

To customize disabled styles, it is recommended to use both &:disabled and &[data-disabled] selectors:

• &:disabled is used to style the button when the disabled prop is set and also when the button is disabled by the parent component (for example, when the disabled prop is set on a <fieldset /> element which contains the Button).
• &[data-disabled] is used to style the button when it is not actually disabled but should look like it is (for example, data-disabled should be used if you need to use Tooltip with a disabled Button or when the Button is used as a link)

Disabled button with Tooltip

The onMouseLeave event is not triggered when a Button is disabled, so if you need to use a Tooltip with a disabled Button, you need to set the data-disabled prop on the Button instead of disabled. Note that it is also required to change the onClick event handler to (event) => event.preventDefault() as the Button is not actually disabled and will still trigger the onClick event.

Loading state

When the loading prop is set, the Button will be disabled and a Loader with overlay will be rendered in the center of the button. Loader color depends on the Button variant.

Loader props

You can customize the Loader with the loaderProps prop, which accepts all props that the Loader component has:

Example of customizing Button with Styles API and data-* attributes:

Custom variants

To add new Button variants, use the data-variant attribute. Usually new variants are added to the theme, this way they are available in all Button components in your application.

Customize variant colors

You can customize colors for Button and other component variants by adding variantColorResolver to your theme.

Button.Group

Note that you must not wrap child Button components with any additional elements:

import { Button } from '@mantine/core';

function Demo() {
  return (
    <Button.Group>
      <div>
        <Button>This will not work</Button>
      </div>
      <Button>Buttons will have incorrect borders</Button>
    </Button.Group>
  );
}

Button.GroupSection

Use Button.GroupSection component to render sections that are not buttons inside Button.Group:

<Polymorphic defaultElement="button" changeToElement="a" component="Button" withNext />