# closure-react-notched-outline

> Material Componens React Notched Outline

Latest version **0.7.9** (published 2018-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install closure-react-notched-outline
pnpm add closure-react-notched-outline
yarn add closure-react-notched-outline
bun add closure-react-notched-outline
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.9 |
| Published | 2018-12-26 |
| First published | 2018-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 136.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | yang_ji |
| Keywords | mdc web react, material components react, material design, notched outline, notchedoutline |

## Links

- npm: https://www.npmjs.com/package/closure-react-notched-outline
- Repository: https://github.com/material-components/material-components-web-react
- Homepage: https://github.com/material-components/material-components-web-react#readme
- Issues: https://github.com/material-components/material-components-web-react/issues
- npm.io page: https://npm.io/package/closure-react-notched-outline

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.4.2
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.1
- [@material/notched-outline](https://npm.io/package/@material/notched-outline.md) ^0.41.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.7.9 (latest) — 2018-12-26
- 0.7.8 — 2018-12-24
- 0.7.7 — 2018-12-21
- 0.7.6 — 2018-12-19
- 0.7.5 — 2018-12-19

## README

# React Notched Outline

A React version of an [MDC Notched Outline](https://github.com/material-components/material-components-web/tree/master/packages/mdc-notched-outline).

## Installation

```
npm install @material/react-notched-outline
```

## Usage

### Styles

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

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

### Javascript Instantiation

```js
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](https://github.com/material-components/material-components-web/blob/master/packages/mdc-notched-outline/README.md#sass-mixins)

---
_Source: https://npm.io/package/closure-react-notched-outline · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
