Package Exports

@rmwc/ripple
@rmwc/ripple/README.md
@rmwc/ripple/dist/index.js
@rmwc/ripple/next/index.js
@rmwc/ripple/styles
@rmwc/ripple/styles.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rmwc/ripple) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 @rmwc/ripple
Import styles:
- Using CSS Loader
  - import '@rmwc/ripple/styles';
- Or include stylesheets
  - '@material/ripple/dist/mdc.ripple.css'
MDC Docs: https://material.io/develop/web/components/ripples/

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

<Ripple>
  <p>Standard Ripple</p>
</Ripple>

<Ripple primary>
  <p>Primary</p>
</Ripple>

<Ripple accent>
  <p>Accent</p>
</Ripple>

<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