Button

Render button or link with button styles from mantine theme
Import

Usage

Color
Radius
xs
sm
md
lg
xl
Size
xs
sm
md
lg
xl
import { Button } from '@mantine/core';
function Demo() {
return (
<Button>
Settings
</Button>
);
}

Variants

Gradient variant

To use gradient as Button background:

  • set variant to gradient
  • set gradient to { from: 'color-from', to: 'color-to', deg: 135 }, where
    • color-from and color-to are color from theme.colors
    • deg is linear gradient deg
import { Button } from '@mantine/core';
function Demo() {
return (
<>
<Button variant="gradient" gradient={{ from: 'indigo', to: 'cyan' }}>Indigo cyan</Button>
<Button variant="gradient" gradient={{ from: 'teal', to: 'lime', deg: 105 }}>Lime green</Button>
<Button variant="gradient" gradient={{ from: 'teal', to: 'blue', deg: 60 }}>Teal blue</Button>
<Button variant="gradient" gradient={{ from: 'orange', to: 'red' }}>Orange red</Button>
<Button variant="gradient" gradient={{ from: '#ed6ea0', to: '#ec8c69', deg: 35 }}>Peach</Button>
</>
);
}

White variant

White is a variant in which button background color is always white (both in light and dark theme) and color is controlled with color prop:

Color
import { Button } from '@mantine/core';
import { IconDatabase } from '@tabler/icons';
function Demo() {
return (
<Button leftIcon={<IconDatabase />} variant="white">
Connect to database
</Button>
);
}

Loading state

Button supports loading state. In this state Loader component replaces left or right icon, button becomes disabled and white or dark overlay is added.

You can control loading state and Loader component with following props:

  • loading – enable loading state
  • loaderPosition – Loader position relative to button label, either right or left
  • loaderProps – props spread to Loader component, you can choose loader type, size and any other supported prop
LoaderPosition
import { IconDatabase } from '@tabler/icons';
import { Button } from '@mantine/core';
function Demo() {
return (
<Button leftIcon={<IconDatabase size={14} />}>
Connect to database
</Button>
);
}

Styles API

import { Button } from '@mantine/core';
import { IconBrandTwitter } from '@tabler/icons';
function Demo() {
return (
<Button
component="a"
target="_blank"
rel="noopener noreferrer"
href="https://twitter.com/mantinedev"
leftIcon={<IconBrandTwitter size={18} />}
styles={(theme) => ({
root: {
backgroundColor: '#00acee',
border: 0,
height: 42,
paddingLeft: 20,
paddingRight: 20,
'&:hover': {
backgroundColor: theme.fn.darken('#00acee', 0.05),
},
},
leftIcon: {
marginRight: 15,
},
})}
>
Follow on Twitter
</Button>
);
}

Compact

import { Button } from '@mantine/core';
function Demo() {
return <Button compact>My compact button</Button>;
}

Full width and overflow

Button can take full width of container if you set fullWidth prop. If button is too large for its container, overflow content will be hidden:

import { Button } from '@mantine/core';
function Demo() {
return (
<>
<div style={{ width: 200 }}>
<Button fullWidth variant="outline">
Full width button
</Button>
</div>
<div style={{ width: 140 }}>
<Button fullWidth variant="outline">
Button with overflow
</Button>
</div>
</>
);
}

Button.Group

Orientation
import { Button } from '@mantine/core';
function Demo() {
return (
<Button.Group>
<Button variant="default">First</Button>
<Button variant="default">Second</Button>
<Button variant="default">Third</Button>
</Button.Group>
);
}

Note that you cannot 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>
);
}

If you want to use Tooltip, Popover or other overlay component, it is required to set withinPortal prop:

import { Button, Tooltip } from '@mantine/core';
function Demo() {
return (
<Button.Group>
<Tooltip label="Working as expected" withinPortal>
<Button>With Tooltip</Button>
</Tooltip>
<Button>Regular button</Button>
</Button.Group>
);
}

data- attributes

Button has the following attributes on the root element:

  • data-disabled when disabled prop is true
  • data-loading when loading prop is true

You can customize disabled and loading styles with these attributes:

import { Button } from '@mantine/core';
function Demo() {
return (
<Button
sx={{
'&[data-disabled]': { opacity: 0.4 },
'&[data-loading]': { backgroundColor: 'red' },
}}
/>
);
}

Polymorphic component

Button is a polymorphic component, you can change root element:

import { Button } from '@mantine/core';
import { IconExternalLink } from '@tabler/icons';
function Demo() {
return (
<Button component="a" href="#" variant="outline" leftIcon={<IconExternalLink size={14} />}>
Open in new tab
</Button>
);
}

Usage with react-router

import { Link } from 'react-router-dom';
import { Button } from '@mantine/core';
function Demo() {
return (
<Button component={Link} to="/react-router">
React router link
</Button>
);
}

Usage with Next.js

import Link from 'next/link';
import { Button } from '@mantine/core';
function Demo() {
return (
<Link href="/hello" passHref>
<Button component="a">Next link</Button>
</Link>
);
}

Get ref

import { useRef } from 'react';
import { Button } from '@mantine/core';
function Demo() {
const ref = useRef<HTMLButtonElement>(null);
return <Button ref={ref} />;
}
Download more icon variants from https://tabler-icons.io/i/search

Button component props

NameTypeDescription
children
ReactNode
Button label
color
MantineColor
Button color from theme
compact
boolean
Reduces vertical and horizontal spacing
disabled
boolean
Disabled state
fullWidth
boolean
Sets button width to 100% of parent element
gradient
MantineGradient
Controls gradient settings in gradient variant only
leftIcon
ReactNode
Adds icon before button label
loaderPosition
"left" | "right"
Loader position relative to button label
loaderProps
LoaderProps
Props spread to Loader component
loading
boolean
Indicate loading state
radius
number | "xs" | "sm" | "md" | "lg" | "xl"
Button border-radius from theme or number to set border-radius in px
rightIcon
ReactNode
Adds icon after button label
size
"xs" | "sm" | "md" | "lg" | "xl"
Predefined button size
type
"button" | "reset" | "submit"
Button type attribute
uppercase
boolean
Set text-transform to uppercase
variant
"outline" | "white" | "light" | "default" | "filled" | "subtle" | "gradient"
Controls button appearance

Button.Group component props

NameTypeDescription
buttonBorderWidth
number
Child <Button /> border width in px
children
ReactNode
<Button /> components
orientation
"horizontal" | "vertical"
Switch between vertical and horizontal orientation

Button component Styles API

NameStatic selectorDescription
root.mantine-Button-rootRoot button element
icon.mantine-Button-iconShared icon styles
leftIcon.mantine-Button-leftIconLeft icon
rightIcon.mantine-Button-rightIconRight icon
inner.mantine-Button-innerContains label, left and right icons
label.mantine-Button-labelContains button children