3.0.0 • Published 3 years ago

@arterial/fab v3.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Arterial FAB

Another React Material FAB

Installation

npm install @arterial/fab

Usage

Styles

Sass

@use "@material/fab/index.scss" as fab;
@include fab.core-styles;

CSS

import '@material/fab/dist/mdc.fab.css';

JSX

import {Fab} from '@arterial/fab';

Regular FAB

<Fab icon="favorite" />

Mini FAB

A mini FAB should be used on smaller screens. Mini FABs can also be used to create visual continuity with other screen elements.

<Fab icon="favorite" mini />

Extended FAB

The extended FAB is wider, and it includes a text label.

<Fab extended icon="add" label="Create" />

Other Variants

Trailing Icon

<Fab extended label="Create" trailingIcon="add" />

Text

Unlike standard FABs, extended FABs don't require an icon.

<Fab extended label="Create" />

Props

Fab

NameTypeDescription
classNamestringClasses to be applied to the root element.
exitedbooleanAnimates FAB out of view.
extendedbooleanEnables a extended variant.
iconstring | nodeIcon to render within root element.
labelstringText to be displayed within the root element.
outlinedbooleanEnables an outlined variant.
minibooleanEnables a mini variant.
ripplebooleanEnables ripple within root element. Defaults to true.
tagstring | objectHTML tag to be applied to the root element. Defaults to button.
trailingIconstring | nodeIcon to render on the right side of the root element.
3.0.0

3 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.2.0

4 years ago

1.1.0

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

1.0.3

4 years ago

1.0.0-alpha.6

4 years ago

1.0.0-alpha.5

4 years ago

1.0.0-alpha.4

4 years ago

1.0.0-alpha.3

4 years ago

1.0.0-alpha.1

4 years ago

1.0.0-alpha.0

4 years ago