velocity README

The project's README from github.com/julianshapiro/velocity. As one markdown file: README.md.

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="//cdn.jsdelivr.net/npm/[email protected]/velocity.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/velocity/2.0.6/velocity.min.js"></script>

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

<script src="//cdn.jsdelivr.net/npm/[email protected]/velocity.ui.min.js"></script>
<script src="//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.

velocity (julianshapiro/velocity)

Searching Database…

17.2K ·GitHub
What is this?A fast, feature-rich JavaScript animation engine for web pages: it animates UI elements with better performance than jQuery's $.animate(), and companies like WhatsApp and Uber rely on it.
Is this a jQuery plugin or a standalone library?A standalone library, not a plugin. If jQuery or Zepto is on the page it adds a .velocity() chained method, but it must load after them; for anything loaded later there is Velocity.patch().
How do I add it to my project?Install with 'npm install velocity-animate@beta', or drop in a script from a CDN - JSDelivr can serve the latest release while CloudFlare needs a pinned version. A separate UI pack is also available via CDN.
The npm install says beta but the docs site talks about V1 - which version am I actually getting?You get the 2.0 beta, a complete TypeScript refactoring, while velocityjs.org still documents V1 - for V2 you have to rely on the project wiki instead of the main docs site.
Why use it instead of CSS transitions or jQuery's animate?Per the README, CSS transitions are meant for simple interface flourishes, jQuery's $.animate() is slow and poorly-equipped for motion design, and Velocity is the fast, feature-rich alternative.
What can it animate, feature-wise?Changelog highlights: pause/resume per element or globally, custom easings and tweens, color animation including color names and rgba values, unit conversions, and stop/finish commands.
Who uses Velocity in production?WhatsApp, Tumblr, Windows, Samsung, Uber and thousands of other companies, per the README; Libscore.com shows which sites load it on their homepage.
Is there a version for React?Yes - the README announces a React plugin, separate from the core velocity-animate package.
What are similar projects?jquery-ui, motion, jquery, typeahead.js, anime, vivus, masonry, GSAP
Size
7.9 MB
Stars
17.2K
Age
12y
Commits · 90 Days