# @material/react-line-ripple

> Material Components React Line Ripple

Latest version **0.15.0** (published 2019-07-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @material/react-line-ripple
pnpm add @material/react-line-ripple
yarn add @material/react-line-ripple
bun add @material/react-line-ripple
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.15.0 |
| Published | 2019-07-22 |
| First published | 2018-05-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 71.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | abhiomkar, acdvorak, aprigogin, azakus, bicknellr, bonniez, bwobrien, kfranqueiro, lynnjepsen, material-admin, moog16, patrickrodee, williamernest |
| Keywords | mdc web react, material components react, material design, material line-ripple, materialline-ripple |

## Links

- npm: https://www.npmjs.com/package/@material/react-line-ripple
- 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/@material/react-line-ripple

## Dependencies (2)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [@material/line-ripple](https://npm.io/package/@material/line-ripple.md) ^1.0.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.15.0 (latest) — 2019-07-22
- 0.14.1 — 2019-07-02
- 0.14.0 — 2019-06-25
- 0.13.0 — 2019-05-30
- 0.12.0 — 2019-05-01
- 0.11.0 — 2019-03-19
- 0.8.0 — 2018-12-28
- 0.7.1 — 2018-11-30
- 0.7.0 — 2018-11-20
- 0.6.2 — 2018-11-07
- 0.6.1 — 2018-10-25
- 0.6.0 — 2018-10-24
- 0.5.1 — 2018-09-25
- 0.5.0 — 2018-09-25
- 0.4.1 — 2018-08-13
- … 4 more at https://npm.io/package/@material/react-line-ripple/versions

## README

# React Line Ripple

A React version of an [MDC Line Ripple](https://github.com/material-components/material-components-web/tree/master/packages/mdc-line-ripple).

## Installation

```
npm install @material/react-line-ripple
```

## Usage

### Styles

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

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

### Javascript Instantiation

```js
import LineRipple from '@material/react-line-ripple';

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

## Props

Prop Name | Type | Description
--- | --- | ---
active | boolean | Activates or deactivates the line ripple state.
className | string | Classes to be applied to the root element.
rippleCenter | number | Sets the center of the ripple animation.
style | object | Inline styles of root element.

## 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-line-ripple/README.md#sass-mixins)

---
_Source: https://npm.io/package/@material/react-line-ripple · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._