v-trof / Ripple.js

Proper Material Design ripple effect for the web, that wouldn't interfere your elements' DOM.
17 stars 0 forks source link

Create API docs #5

Closed v-trof closed 7 years ago

v-trof commented 7 years ago

Basically Options = { color: "#757575", opacity: 0.15, borderRadius: 'auto', borderWidth: 'auto', zIndex: 999, transitionDuration: 375, timingFunction: "cubic-bezier(.4,0`,.42,1)", //timing function constant: false // enlarging speed is constant }


ripple.bind_to(elements<NodeList | Array of nodes | Node>, options = {}) sets listentes to call given elements returns { factory, // use factory.rippleProps to set options afterwards remove() // removes all listeners }

ripple.watch(selector = '*', options = {}, scope=document), sets listentes to call on elements matching selector inside of the scope returns { factory, // use factory.rippleProps to set options afterwards remove() // removes all listeners }

ripple.setDefaults(options = {}) extends default options for all rippleFactories that would create ripple afterwards, would not affect binds already done