Skip to content

Fab API

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

Component demos

Import

import Fab from '@mui/material/Fab';
// or
import { Fab } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

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


color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Type:'default'
| 'error'
| 'info'
| 'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'warning'
| string

Default:'default'


component

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

Type:elementType


disabled

If true, the component is disabled.

Type:bool

Default:false


disableFocusRipple

If true, the keyboard focus ripple is disabled.

Type:bool

Default:false


disableRipple

If true, the ripple effect is disabled.

Type:bool


href

The URL to link to when the button is clicked. If defined, an a element will be used as the root node.

Type:string


size

The size of the component. small is equivalent to the dense button styling.

Type:'small'
| 'medium'
| 'large'
| string

Default:'large'


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


variant

The variant to use.

Type:'circular'
| 'extended'
| string

Default:'circular'


The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in Fab. You can take advantage of this to target nested components.


Theme default props

You can use MuiFab to change the default props of this component with the theme.


CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.Mui-disabledSTATE

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


.Mui-focusVisibleSTATE

State class applied to the ButtonBase root element if the button is keyboard focused.


.MuiFab-circular

Styles applied to the root element if variant="circular".

Rule name:circular


.MuiFab-colorInherit

Styles applied to the root element if color="inherit".

Rule name:colorInherit


.MuiFab-extended

Styles applied to the root element if variant="extended".

Rule name:extended


.MuiFab-primary

Styles applied to the root element if color="primary".

Rule name:primary


.MuiFab-root

Styles applied to the root element.

Rule name:root


.MuiFab-secondary

Styles applied to the root element if color="secondary".

Rule name:secondary


.MuiFab-sizeMedium

Styles applied to the root element if size="medium"`.

Rule name:sizeMedium


.MuiFab-sizeSmall

Styles applied to the root element if size="small"`.

Rule name:sizeSmall



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

Edit this page

Was this page helpful?


DrawerFade

Blog

Store