Fab API
API documentation for the React Fab component. Learn about the available props, and the CSS API.
Import
import Fab from '@material-ui/core/Fab';
// or
import { Fab } from '@material-ui/core';Component name
The nameMuiFab can be used when providing default props or style overrides in the theme.Props
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | The content of the button. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | 'default' | 'inherit' | 'primary' | 'secondary' | 'default' | The color of the component. It supports those theme colors that make sense for this component. |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
| disabled | bool | false | If true, the button is disabled. |
| disableFocusRipple | bool | false | If true, the keyboard focus ripple is disabled. |
| disableRipple | bool | false | If true, the ripple effect is disabled. |
| href | string | The URL to link to when the button is clicked. If defined, an a element will be used as the root node. | |
| size | 'large' | 'medium' | 'small' | 'large' | The size of the button. small is equivalent to the dense button styling. |
| variant | 'circular' | 'extended' | string | 'circular' | The variant to use. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (ButtonBase).
Inheritance
While not explicitly documented above, the props of the ButtonBase component are also available on Fab. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiFab-root | Styles applied to the root element. |
| label | .MuiFab-label | Styles applied to the span element that wraps the children. |
| primary | .MuiFab-primary | Styles applied to the root element if color="primary". |
| secondary | .MuiFab-secondary | Styles applied to the root element if color="secondary". |
| extended | .MuiFab-extended | Styles applied to the root element if variant="extended". |
| circular | .MuiFab-circular | Styles applied to the root element if variant="circular". |
| focusVisible | .Mui-focusVisible | Pseudo-class applied to the ButtonBase root element if the button is keyboard focused. |
| disabled | .Mui-disabled | Pseudo-class applied to the root element if disabled={true}. |
| colorInherit | .MuiFab-colorInherit | Styles applied to the root element if color="inherit". |
| sizeSmall | .MuiFab-sizeSmall | Styles applied to the root element if size="small"`. |
| sizeMedium | .MuiFab-sizeMedium | Styles applied to the root element if size="medium"`. |
You can override the style of the component using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.