@element-public/react-ripple

Ripple

Description

Interactive effect applied on click or on touch.

Install bundle from npm-e

npm i @element-public/react-components @element-public/themes

Optional: install the component individually

npm i @element-public/react-ripple @element-public/themes

Please Note: You will need to add @element-public to your .npmrc!

Open ~/.npmrc in an editor and add the following line to enable the @element-public scope:

@element-public:registry=https://npm.platforms.engineering

Troubleshooting

See below if you have never installed a package from Bayer's npm-enterprise or run into the following error:

npm ERR! code E401
npm ERR! Unable to authenticate, your authentication token seems to be invalid.
npm ERR! To correct this please trying logging in again with:
npm ERR!     npm login

Setup an access token

See the devtools npm-e guide to learn how to create an access token if this is the first time you are using a npm-e package at Bayer or you do not have a line that starts with the following in your ~/.npmrc file:

//npm.platforms.engineering/:_authToken=

Ripple Props

Name	Type	Default	Required	Description
componentRef	object	undefined	false	A reference to the component to apply the ripple to.
unbounded	boolean	undefined	false	Allows the ripple to extend beyond the component boundaries.

Ripple Render Props

Name	Type	Default	Required	Description
children	React.ReactNode	null	false	Content to be rendered inside the component.