closure-react-fab

Material Components React Floating Action Button (FAB)

Usage no npm install needed!

<script type="module">
  import closureReactFab from 'https://cdn.skypack.dev/closure-react-fab';
</script>

README

React Floating Action Button

A React version of an MDC Floating Action Button.

Installation

npm install @material/react-fab

Usage

Styles

with Sass:

import '@material/react-fab/index.scss';

with CSS:

import '@material/react-fab/dist/fab.css';

JSX Structure

The Fab can be used with the span, i, img or svg elements. It can also be used with the Material Icon react component.

<Fab icon={<span className="material-icons">favorite</span>}/>

<Fab icon={<i className="material-icons">favorite</i>}/>

<Fab icon={
  <svg xmlns="http://www.w3.org/2000/svg" className="material-icons" viewBox="0 0 24 24">
  ...
  </svg>
  }/>

<Fab icon={<img className="material-icons" src="/images/ic_button_24px.svg"/>}/>

<Fab icon={<MaterialIcon icon="favorite"/>}/>

Props

Prop Name Type Description
className String Classes to be applied to the root element.
mini n/a Enables the mini variant.
icon Element The icon.
textLabel String The label, which makes the FAB extended.

Sass Mixins

Sass mixins may be available to customize various aspects of the components. Please refer to the MDC Web repository for more information on what mixins are available, and how to use them.

Advanced Sass Mixins

Usage with Icons

Please see our Best Practices doc when importing or using icon fonts.