@material/react-notched-outline
v0.15.0
Published
Material Componens React Notched Outline
Downloads
7,078
Readme
React Notched Outline
A React version of an MDC Notched Outline.
Installation
npm install @material/react-notched-outline
Usage
Styles
with Sass:
import '@material/react-notched-outline/index.scss';
with CSS:
import '@material/react-notched-outline/dist/notched-outline.css';
Javascript Instantiation
import NotchedOutline from '@material/react-notched-outline';
import FloatingLabel from '@material/react-floating-label';
const MyComponent = () => {
return (
<NotchedOutline notch>
<FloatingLabel float>My Label</FloatingLabel>
</NotchedOutline>
);
}
Variant with No Notch
import NotchedOutline from '@material/react-notched-outline';
const MyComponent = () => {
return (
<React.Fragment>
<label>My Label</label>
<NotchedOutline />
</React.Fragment>
);
}
Props
Prop Name | Type | Description --- | --- | --- className | String | Classes to be applied to the root element. notch | Boolean | Toggles between notched outline and idle outline state. notchWidth | Number | Width of the notch in the outline.
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.