docs(ripple): update ripple docs and add usage

This commit is contained in:
Brandy Carney
2018-07-05 18:41:07 -04:00
parent 41a0989986
commit 400b9e8cf5
4 changed files with 2221 additions and 2254 deletions

4453
core/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -26,7 +26,7 @@
"ionicons": "4.1.2" "ionicons": "4.1.2"
}, },
"devDependencies": { "devDependencies": {
"@stencil/core": "^0.9.9", "@stencil/core": "^0.10.0-6",
"@stencil/dev-server": "latest", "@stencil/dev-server": "latest",
"@stencil/sass": "latest", "@stencil/sass": "latest",
"@stencil/utils": "latest", "@stencil/utils": "latest",

View File

@ -1,9 +1,6 @@
# ion-ripple-effect # ion-ripple-effect
RippleEffect is component that adds the Material Design button ripple effect. The ripple effect component adds the [Material Design ink ripple interaction effect](https://material.io/develop/web/components/ripples/). This component can be used without a button and can be added to any component.
This is the stand alone version of the ripple effect and can be added to any component.
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
@ -15,6 +12,8 @@ This is the stand alone version of the ripple effect and can be added to any com
boolean boolean
If true, the ripple effect will listen to any click events and animate
## Attributes ## Attributes
@ -22,6 +21,8 @@ boolean
boolean boolean
If true, the ripple effect will listen to any click events and animate
## Methods ## Methods

View File

@ -0,0 +1,11 @@
```html
<div>
<ion-ripple-effect></ion-ripple-effect>
A plain div with a ripple effect
</div>
<button>
<ion-ripple-effect></ion-ripple-effect>
Button
</button>
```