# @pmwcs/ripple

> PMWCS ripple component

Latest version **1.1.0** (published 2021-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pmwcs/ripple
pnpm add @pmwcs/ripple
yarn add @pmwcs/ripple
bun add @pmwcs/ripple
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-06-20 |
| First published | 2020-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 41.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Maintainers | commenthol |
| Keywords | pmwcs, preact, material, web, components, ripple |

## Links

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

## Dependencies (3)

- [@pmwcs/base](https://npm.io/package/@pmwcs/base.md) ^1.1.0
- [@pmwcs/provider](https://npm.io/package/@pmwcs/provider.md) ^1.1.0
- [@material/ripple](https://npm.io/package/@material/ripple.md) ^7.0.0

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@mesalvo/react-ui](https://npm.io/package/@mesalvo/react-ui.md) — 1.7K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-06-20
- 1.0.0-2 (next) — 2020-09-05
- 1.0.2 — 2020-12-30
- 1.0.1 — 2020-10-11
- 1.0.0 — 2020-10-07
- 1.0.0-1 — 2020-08-30

## README

# Ripples

MDC Ripple provides the JavaScript and CSS required to provide components (or any element at all) with a material “ink ripple” interaction effect. It is designed to be efficient, uninvasive, and usable without adding any extra DOM to your elements.

- Module **@pmwcs/ripple**
- Import styles:
  - Using CSS Loader
    - import '@pmwcs/ripple/styles';
  - Or include stylesheets
    - **'@material/ripple/dist/mdc.ripple.css'**
- MDC Docs: [https://material.io/develop/web/components/ripples/](https://material.io/develop/web/components/ripples/)

Ripples will wrap whatever child component you pass it and apply the appropriate classes and styles.

```jsx
<Ripple>
  <p>Standard Ripple</p>
</Ripple>
```

```jsx
<Ripple primary>
  <p>Primary</p>
</Ripple>
```

```jsx
<Ripple accent>
  <p>Accent</p>
</Ripple>
```

```jsx
<Ripple unbounded>
  <p>Unbounded</p>
</Ripple>
```

## Ripple
A component for adding Ripples to other components.

### Props

| Name | Type | Description |
|------|------|-------------|
| `accent` | `undefined \| false \| true` | Makes the ripple an accent color |
| `disabled` | `undefined \| false \| true` | makes the ripple disabled |
| `foundationRef` | `React.Ref<MDCRippleFoundation>` | Advanced: A reference to the MDCFoundation. |
| `primary` | `undefined \| false \| true` | Makes the ripple primary |
| `surface` | `undefined \| false \| true` | For internal use |
| `unbounded` | `undefined \| false \| true` | Makes the ripple unbounded |

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