closure-react-notched-outline

Material Componens React Notched Outline

Usage no npm install needed!

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

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';

const MyComponent = () => {
  return (
    <NotchedOutline />
  );
}

Props

Prop Name Type Description
className String Classes to be applied to the root element.
isRtl Boolean Shifts notch to right side if true.
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.

Advanced Sass Mixins