1.2.0 • Published 5 years ago
v-ripple-effect v1.2.0
v-ripple-effect
A Vue directive that creates a ripple effect on any element (like from Material UI or Vuetify).
Installation
npm i v-ripple-effectRegistering the directive in Vue:
// Global Instance - in your main.js file
import ripple from 'v-ripple-effect';
Vue.use(ripple);
// Single Instance
new Vue({
directives: { ripple }
})Options
| Property | Description | Type | Default |
|---|---|---|---|
| time | The number of seconds for the ripple to complete its animation. | Number or Float | 1 |
| ease | The easing function of the ripple. | String | 'ease' |
| color | The color of the ripple. | String | '#000' |
| startingOpacity | The opacity the ripple will start with when the animation begins. | Float (0 to 1) | 0.2 |
Usage
Ripple can be applied onto an element by using "v-ripple".
Basic usage example:
<div v-ripple></div>Examples
<div v-ripple="{ time: 1.2, ease: 'ease-in', color: '#ff0000', startingOpacity: 0.5 }"></div><button v-ripple="{ time: 0.3, ease: 'linear', color: 'rgb(255, 255, 255)' }"></button>