# @anypoint-web-components/material-ripple

> Adds a material design ripple to any container. It's a port of @polymer/paper-ripple for ESM.

Latest version **1.0.3** (published 2021-09-01) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @anypoint-web-components/material-ripple
pnpm add @anypoint-web-components/material-ripple
yarn add @anypoint-web-components/material-ripple
bun add @anypoint-web-components/material-ripple
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-09-01 |
| First published | 2021-07-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 26.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Pawel Uchida-Psztyc |
| Maintainers | jarrodek, twoplustwoone, lbauret, carowright |
| Keywords | web-components, anypoint, ripple, material design |

## Links

- npm: https://www.npmjs.com/package/@anypoint-web-components/material-ripple
- Repository: https://github.com/anypoint-web-components/material-ripple
- Homepage: https://github.com/anypoint-web-components/material-ripple#readme
- Issues: https://github.com/anypoint-web-components/material-ripple/issues
- npm.io page: https://npm.io/package/@anypoint-web-components/material-ripple

## Dependencies (2)

- [lit-element](https://npm.io/package/lit-element.md) ^2.4.0
- [@advanced-rest-client/arc-icons](https://npm.io/package/@advanced-rest-client/arc-icons.md) ^3.3.3

## Recent versions

- 1.0.3 (latest) — 2021-09-01
- 1.0.2 — 2021-07-08
- 1.0.1 — 2021-07-07
- 1.0.0 — 2021-07-07

## README

# `<material-ripple>`

This is a port of `@polymer/paper-ripple` to ListElement and ES modules. It also removes Polymer dependencies.

[![Published on NPM](https://img.shields.io/npm/v/@anypoint-web-components/material-ripple.svg)](https://www.npmjs.com/package/@anypoint-web-components/material-ripple)

[![Testing](https://github.com/anypoint-web-components/material-ripple/actions/workflows/deployment.yml/badge.svg)](https://github.com/anypoint-web-components/material-ripple/actions/workflows/deployment.yml)

## Usage

### Installation

```sh
npm i --save @anypoint-web-components/material-ripple
```

### In an HTML file

```html
<html>
  <head>
    <script type="module">
      import '@anypoint-web-components/material-ripple/material-ripple.js';
    </script>
  </head>
  <body>
    <div style="position: relative">
       <material-ripple>Click me</material-ripple>
    </div>
  </body>
</html>
```

## Development

```sh
git clone https://github.com/anypoint-web-components/material-ripple
cd material-ripple
npm install
```

### Running the demo locally

```sh
npm start
```

### Running the tests

```sh
npm test
```

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