/ractive-transitions-velocity

Velocity.js based transitions for Ractive.js

Primary LanguageJavaScriptMIT LicenseMIT

Ractive.js velocity transition plugin

This plugin let you use Velocity.js to make Ractive.js transitions, with full support for all of Velocity.js' properties and options (except complete, which is used by the plugin itself) And if you add the Velocity.js UI Pack aling with Velocity.js (optional, but recommended), all the packaged effects will be readily available as transitions too.

See the demo here.

Find more Ractive.js plugins at docs.ractivejs.org/latest/plugins

Usage

Include this file on your page below Ractive, jQuery, velocity and (optional) velocity.ui e.g:

<script src='lib/ractive.js'></script>
<script src='lib/jquery.js'></script>
<script src='lib/jquery.velocity.js'></script>
<script src='lib/velocity.ui.js'></script>
<script src='lib/ractive-transitions-velocity.js'></script>

Or, if you're using a module loader, require this module after jquery, velocity and (optional) velocity.ui:

// requiring the plugin will 'activate' it - no need to use the return value
require( 'ractive-transitions-velocity' );

You can then roll your own transitions using a properties object and (optional) options object or duration in ms

<p intro="velocity:{opacity:[ 1, 0 ]},1000">intro="velocity:{opacity:[ 1, 0 ]},1000"</p>
<p intro="velocity:{translateX: [ 0, [3], 500 ],opacity:[ 1, [8], 0 ]},{duration:1000,loop:2}">intro="velocity:{translateX: [ 0, [3], 500 ],opacity:[ 1, [8], 0 ]},{duration:1000,loop:2}"</p>

If you add the UI Pack, you can use the provided effects by their name instead of the properties object

<p intro="velocity:'transition.flipBounceXIn',{duration:3000}">intro="velocity:'transition.flipBounceXIn',{duration:3000}"</p>
<p intro="velocity:'transition.fadeIn',4000">intro="velocity:'transition.fadeIn',4000"</p>

Bonus IF the UI Pack is added, all effects will be available as Ractive transitions directly

<p intro="transition.whirlIn">intro="transition.whirlIn"</p>
<p intro="transition.bounceLeftIn:3000">intro="transition.bounceLeftIn:3000"</p>

NOTE! The complete option is not available, as it is overwritten by the transition internals

Credits

@julianshapiro for creating Velocity.js

@Rich-Harris for creating Ractive.js

License

Licensed MIT (c) 2014 Jens Anders Bakke. (https://twitter.com/cfenzo)

Created with the Ractive.js plugin template for Grunt.