React Floating Label

A React version of an MDC Floating Label.

Installation

``
npm install @material/react-floating-label
`

Usage

$3

with Sass:
`js
import '@material/react-floating-label/index.scss';
`

with CSS:
`js
import '@material/react-floating-label/dist/floating-label.css';
`

$3

React Floating Label is meant to be used with other Components, specifically input type elements. Floating label is positioned absolute, which requires the parent element to be position _relative_.

$3

To shake the label you'll need to add a _ref_ to the element. Using the ref, you can then call shake() to start the shake animation. Ex:

`js
import FloatingLabel from '@material/react-floating-label';

class MyComponent extends React.Component {
constructor(props) {
super(props);
// createRef was introduce in React v16.3
// https://reactjs.org/docs/refs-and-the-dom.html#creating-refs
this.floatingLabelElement = React.createRef();
}

render() {
return (

My Label

);
}

// ... later in code ...

this.floatingLabelElement.current.shake();
}
`

$3

Label width is set during mount, and is calculated from the offsetWidth property. The Component will call handleWidthChange() when mounted. handleWidthChange() will execute with a new width value if this.props.children changes.

`js
handleWidthChange={(width) => this.setState({width})}
>
My Label

``

Props

Prop Name | Type | Description
--- | --- | ---
className | String | Classes to be applied to the root element.
handleWidthChange | Function | Callback method to pass the width to a parent Component.
float | Boolean | Floats label depending on value passed.

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