feat(ripple): export util from @material/ripple

[Kerrick]

The docs recommend using certain functions from util when implementing an adapter for the ripple foundation. It is not currently possible to import { util } from '@material/ripple';, even though this pattern is established in mdc-toolbar.

[anton-kachurin]

Related issue is #253. It also mentions that docs for ripple need to be expanded.

[codecov-io]

Codecov Report

Merging #751 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master     #751   +/-   ##
=======================================
  Coverage   98.96%   98.96%           
=======================================
  Files          69       69           
  Lines        3181     3181           
  Branches      387      387           
=======================================
  Hits         3148     3148           
  Misses         33       33

Impacted Files	Coverage Δ
packages/mdc-ripple/index.js	100% <100%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 107980a...560648d. Read the comment docs.

[lynnmercier]

Actually, I approved a little too quickly...could you also add documentation to the README? And put Resolves #253: in the body of the commit.

[Kerrick]

The docs already say the following under Using the foundation:

We provide a supportsCssVariables function within the util.js which we recommend using, as it handles this for you.

What more should I document about it?

Also, should I add an example to the ES2015 etc. imports (example below)? Was wondering about that since it's under Adding the ripple JS rather than Using the foundation.

import {MDCRipple, MDCRippleFoundation, util} from '@material/ripple';

I'll be glad to make the requested changes once I'm a bit clearer on what's best. 👍

[lynnmercier]

Mdc-drawer has a good example of documenting The util API

https://github.com/material-components/material-components-web/tree/master/packages/mdc-drawer

Mdc-ripple README should document

• supportsCssVariables
• applyPassive
• getMatchesProperty
• getNormalizedEventCoords

And, again using mdc-drawer as an example, looks like you should add

import {MDCRipple, MDCRippleFoundation, util} from '@material/ripple';

Thank you!

[yeelan0319]

Hi @Kerrick, trying to loop back to see if there is any updates :)

Let us know if there is anything you need us help for clarification.

[Kerrick]

Whoops, sorry about that! Got caught up in a big product launch at work and lost track. Should be able to get these changes back to you shortly.

[Kerrick]

I've pushed the requested changes 👍