[go: up one dir, main page]

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.

DemosImport
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.

NameTypeDefaultDescription
childrennode-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'default'
| 'error'
| 'info'
| 'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'warning'
| string
'default'

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

componentelementType-

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

disabledboolfalse

If true, the component is disabled.

disableFocusRippleboolfalse

If true, the keyboard focus ripple is disabled.

disableRipplebool-

If true, the ripple effect is disabled.

hrefstring-

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

size'small'
| 'medium'
| 'large'
| string
'large'

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

sxArray<func
| object
| bool>
| func
| object
-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

variant'circular'
| 'extended'
| string
'circular'

The variant to use.

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.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-focusVisibleState class applied to the ButtonBase root element if the button is keyboard focused.
.MuiFab-circularcircularStyles applied to the root element if variant="circular".
.MuiFab-colorInheritcolorInheritStyles applied to the root element if color="inherit".
.MuiFab-extendedextendedStyles applied to the root element if variant="extended".
.MuiFab-primaryprimaryStyles applied to the root element if color="primary".
.MuiFab-rootrootStyles applied to the root element.
.MuiFab-secondarysecondaryStyles applied to the root element if color="secondary".
.MuiFab-sizeMediumsizeMediumStyles applied to the root element if size="medium"`.
.MuiFab-sizeSmallsizeSmallStyles applied to the root element if size="small"`.

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.