npm.io
5.88.2-alpha.1 • Published 2 months ago

@element-public/react-ripple

Licence
Version
5.88.2-alpha.1
Deps
5
Size
15 kB
Vulns
0
Weekly
0
DeprecatedThis package is deprecated

Ripple

Description

Interactive effect applied on click or on touch.

Install from Artifactory

  • Verify that you have access to (https://docs.int.bayer.com/cloud/devops/artifactory/)[Bayer Artifactory]
    • Verify your token is correctly set up in your .npmrc as per the link above
  • Verify you have the @element scope configured in your .npmrc
    • @element:registry=https://artifactory.bayer.com/artifactory/api/npm/npm-platforms-engineering/
  • Install the component and themes bundles
    • npm i @element/react-components @element/themes
      • alternatively install the component individually along with the themes bundle npm i @element/react-ripple @element/themes

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.