Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.99 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.99 KB
Raw

Liquid Fire

Comprehensive animation support for ambitious Ember applications. Interactive Documentation is here.

Features

  • Animated transitions between routes that work seamlessly with the Ember router.

  • A DSL for laying out your spatial route relationships, cleanly separated from view-layer implementation details.

  • Animated transitions between models within a single route.

  • Animated transitions between individual scalar values within a template.

  • Promise-driven API to control your animation flow.

  • Backed by velocity.js, but easy to extend to other animation drivers if there's interest.

Ember Compatibility Table

We support a wide range of Ember versions, but you must choose the correct version of liquid-fire:

Ember Version Liquid Fire Branch Liquid Fire Release
1.8 through 1.10 oldstable 0.17
1.11 through 1.12 stable 0.19
1.13 and beyond master 0.21

stable and oldstable branches still receive bugfixes and PRs are welcome, but new feature work happens on master.

Installation

This is an ember-cli addon, so all you need is an npm install. For Ember 1.13 or newer, use:

ember install liquid-fire

For older ember versions, consult the compatibility table above to pick the right liquid-fire version and then install with one of these:

ember install liquid-fire@^0.17.0
ember install liquid-fire@^0.19.0

Documentation

Liquid Fire website is an ember-cli application that contains an interactive demo & documentation. It runs from Liquid Fire's test dummy app.

You can also see some examples in my Ember Animation Demo repo, and this video presentation from the Boston Ember Meetup.

Development

Source Organization

This repo contains both the liquid-fire library and a demo application that presents interactive documentation. It follows standard ember-cli addon format.

  • app: is code that's loaded directly into the user's application
  • addon: is code that can be imported by the user from the liquid-fire namespace
  • tests/dummy: is the testing, demo, and documentation application that runs at http://ef4.github.com/liquid-fire
  • packaging: extra tooling for building non-ember-cli releases

Selecting Ember Versions

Liquid Fire is tested against release, beta, and canaryversions of Ember. While developing Liquid Fire, you can switch to a different Ember environment by using ember-try's ember try ember-1.11.0 script.

After running this command and re-running ember serve, the ember-cli server (and QUnit test suite) will be running against Ember Canary + HTMLBars.