Skip to content
Edit this page

Fab API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiFab-rootroot

Styles applied to the root element.

.MuiFab-primaryprimary

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

.MuiFab-secondarysecondary

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

.MuiFab-extendedextended

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

.MuiFab-circularcircular

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

.Mui-focusVisiblefocusVisibleSTATE

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

.Mui-disableddisabledSTATE

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

.MuiFab-colorInheritcolorInherit

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

.MuiFab-sizeSmallsizeSmall

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

.MuiFab-sizeMediumsizeMedium

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

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