1.1.0 • Published 3 years ago

@pmwcs/ripple v1.1.0

Weekly downloads
5
License
MIT
Repository
github
Last release
3 years ago

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.

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

NameTypeDescription
accentundefined \| false \| trueMakes the ripple an accent color
disabledundefined \| false \| truemakes the ripple disabled
foundationRefReact.Ref<MDCRippleFoundation>Advanced: A reference to the MDCFoundation.
primaryundefined \| false \| trueMakes the ripple primary
surfaceundefined \| false \| trueFor internal use
unboundedundefined \| false \| trueMakes the ripple unbounded