@rmwc/ripple
Advanced tools
Comparing version 14.0.4 to 14.0.5
{ | ||
"name": "@rmwc/ripple", | ||
"version": "14.0.4", | ||
"version": "14.0.5", | ||
"description": "RMWC Ripple component", | ||
@@ -41,3 +41,2 @@ "main": "./index.js", | ||
"peerDependencies": { | ||
"@material/ripple": "^14.0.0", | ||
"react": ">=16.8.x", | ||
@@ -47,6 +46,7 @@ "react-dom": ">=16.8.x" | ||
"dependencies": { | ||
"@rmwc/base": "14.0.4", | ||
"@rmwc/provider": "14.0.4", | ||
"@rmwc/types": "14.0.4" | ||
"@material/ripple": "^14.0.0", | ||
"@rmwc/base": "14.0.5", | ||
"@rmwc/provider": "14.0.5", | ||
"@rmwc/types": "14.0.5" | ||
} | ||
} |
# 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. | ||
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. | ||
@@ -8,5 +8,5 @@ - Module **@rmwc/ripple** | ||
- Using CSS Loader | ||
- import **'@rmwc/ripple/styles';** | ||
- import '@rmwc/ripple/styles'; | ||
- Or include stylesheets | ||
- **'@material/ripple/dist/mdc.ripple.css'**; | ||
- **'@material/ripple/dist/mdc.ripple.css'** | ||
- MDC Docs: [https://material.io/develop/web/components/ripples/](https://material.io/develop/web/components/ripples/) | ||
@@ -16,46 +16,40 @@ | ||
```js | ||
```jsx | ||
<Ripple> | ||
<p>Standard Ripple</p> | ||
</Ripple> | ||
``` | ||
<Ripple\> | ||
<p\>Standard Ripple</p\> | ||
</Ripple\> | ||
```jsx | ||
<Ripple primary> | ||
<p>Primary</p> | ||
</Ripple> | ||
``` | ||
```js | ||
<Ripple primary\> | ||
<p\>Primary</p\> | ||
</Ripple\> | ||
```jsx | ||
<Ripple accent> | ||
<p>Accent</p> | ||
</Ripple> | ||
``` | ||
```js | ||
<Ripple accent\> | ||
<p\>Accent</p\> | ||
</Ripple\> | ||
```jsx | ||
<Ripple unbounded> | ||
<p>Unbounded</p> | ||
</Ripple> | ||
``` | ||
```js | ||
## Ripple | ||
A component for adding Ripples to other components. | ||
<Ripple unbounded\> | ||
### Props | ||
<p\>Unbounded</p\> | ||
| Name | Type | Description | | ||
|------|------|-------------| | ||
| `accent` | `boolean` | Makes the ripple an accent color | | ||
| `disabled` | `boolean` | makes the ripple disabled | | ||
| `foundationRef` | `Ref<MDCRippleFoundation<>>` | Advanced: A reference to the MDCFoundation. | | ||
| `primary` | `boolean` | Makes the ripple primary | | ||
| `surface` | `boolean` | For internal use | | ||
| `unbounded` | `boolean` | Makes the ripple unbounded | | ||
</Ripple\> | ||
``` | ||
## Ripple |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
13532
54
+ Added@material/ripple@^14.0.0
+ Added@rmwc/base@14.0.5(transitive)
+ Added@rmwc/provider@14.0.5(transitive)
+ Added@rmwc/types@14.0.5(transitive)
- Removed@rmwc/base@14.0.4(transitive)
- Removed@rmwc/provider@14.0.4(transitive)
- Removed@rmwc/types@14.0.4(transitive)
Updated@rmwc/base@14.0.5
Updated@rmwc/provider@14.0.5
Updated@rmwc/types@14.0.5