mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-20 12:29:55 +08:00
docs(ripple): update ripple docs and add usage
This commit is contained in:
4453
core/package-lock.json
generated
4453
core/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -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",
|
||||||
|
@ -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
|
||||||
|
|
||||||
|
11
core/src/components/ripple-effect/usage/javascript.md
Normal file
11
core/src/components/ripple-effect/usage/javascript.md
Normal 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>
|
||||||
|
```
|
Reference in New Issue
Block a user