julianshapiro / velocity

Accelerated JavaScript animation.
VelocityJS.org
MIT License
17.29k stars 1.56k forks source link

# Velocity beta

npm npm (tag) cdnjs version npm downloads jsdelivr downloads

NPM: npm install velocity-animate@beta

Docs

https://github.com/julianshapiro/velocity/wiki

IMPORTANT: The velocityjs.org documentation refers to V1, not V2 beta - use the wiki for latest documentation!

News

WhatsApp, Tumblr, Windows, Samsung, Uber, and thousands of other companies rely on Velocity. Visit Libscore.com to see which sites use Velocity on their homepage.

React Plugin

Announcement: https://fabric.io/blog/introducing-the-velocityreact-library
Repo: https://github.com/twitter-fabric/velocity-react
NPM: https://www.npmjs.com/package/velocity-react

Quickstart

Velocity (CDN, choose one of them):

<script src="https://github.com/julianshapiro/velocity/raw/master//cdn.jsdelivr.net/npm/velocity-animate@2.0/velocity.min.js"></script>
<script src="https://github.com/julianshapiro/velocity/raw/master//cdnjs.cloudflare.com/ajax/libs/velocity/2.0.6/velocity.min.js"></script>

Velocity UI pack (CDN, choose one of them):

<script src="https://github.com/julianshapiro/velocity/raw/master//cdn.jsdelivr.net/npm/velocity-animate@2.0/velocity.ui.min.js"></script>
<script src="https://github.com/julianshapiro/velocity/raw/master//cdnjs.cloudflare.com/ajax/libs/velocity/2.0.6/velocity.ui.min.js"></script>

Please note that JSDelivr can automatically supply the latest release, while CloudFlare needs to ask for a specific version.

Package managers:

npm: npm install velocity-animate@beta

Automagic chaining:

If using the .velocity(...) chained function in libraries such as jQuery or Zepto you need to ensure that Velocity is loaded after them. If you wish to add it to anything loaded afterwards then look at the Velocity.patch() method.

Questions or Problems?

Ask on StackOverflow (make sure you add the [velocity.js] and the [javascript] or [typescript] tags).

Updates

Learn

Comparisons

License

MIT License. © Julian Shapiro (http://twitter.com/julian).

Sponsors

Kiss My Button sponsors Velocity's development.

BrowserStack provides browser testing services for Velocity.