🚀 Release v2.0.0

[ncoden]

Motion UI v2.0.0

We're happy to release Motion UI 2.0 with a better support of macOS Safari, API improvements, some bug fixes and various maintanance stuff. Warning: this release includes breaking changes, please read the migration notes below before upgrading.

🚀 Forward/backward defaults for transitions & effects

We changed the default direction of all transition and effect mixins so it depends on the in or out state. Calling the same mixin with in and out states now results in the same animation playing forward and backward.

⚠️ Breaking changes

We changed the effects and transitions API the following way:

• All direction-related options now have opposite values as defaults according to the in or out state.
• The slide effect defaults are now left and right (according to $state) for consistency with the slide transition.
• The zoom transition and effect defaults are now 0 and 1 (according to $state) for consistency with others transitions defaults.

How to migrate

For the hinge, slide, spin, zoom effect functions and mui-fade, mui-hinge, mui-slide, mui-spin, mui-zoom transition mixins: if $state: out is used and no direction parameters are given, manually pass the "forward" parameters to keep them playing forward.

// Before
@include mui-fade($state: out);
// After
@include mui-fade($state: out, $from: 0, $to: 1);

For the slide effect function: if no $direction is given, manually pass $direction: up to keep the effect sliding to top instead of the new default left/right.

// Before
$effect: slide();
// After
$effect: slide($direction: up);

For the mui-zoom transition mixin: if no $from or $to are given, manually pass $from: 1.5 and $to: 1 to keep the previous behavior.

// Before
@include mui-zoom();
// After
@include mui-zoom($from: 1.5, $to: 1);

🚀 New pausing behavior for mui-queue for Safari support

With the previous mui-series behavior, the serie was paused until the .is-animating class was added. Unfortately, the implementation behind this did not work on all macOS Safari versions and was even breaking the whole animation. In order to fully support macOS Safari, we changed the mui-series paused behavior and introduced .is-paused.

⚠️ Breaking changes

When .is-animating is removed from .mui-series, the queue is now reset instead of paused. Setting .is-animating back will start the queue from its begining.

From now you can:

• Start the queue by adding .is-animating
• Pause the queue by adding .is-paused
• Continue the queue by removing .is-paused
• Reset the queue by removing .is-animating

How to migrate

If you need an animation to pause midway, add .is-paused instead of removing .is-animating. For example in jQuery:

// Before
function play($elem) {
  $elem.addClass('is-animating');
}
function pause($elem) {
  $elem.removeClass('is-animating');
}

// After
function play($elem) {
  $elem.addClass('is-animating').removeClass('is-paused');
}
function pause($elem) {
  $elem.addClass('is-paused');
}
function reset($elem) {
  $elem.removeClass('is-animating is-paused');
}

As a side-effect of this, standard animation names are not supported anymore as mui-series queue names. Make sure you use unique names for your mui-series queues.

// Before
@include mui-series {
  .shake          { @include mui-queue(3s, 0s, shake); }
  .spin           { @include mui-queue(3s, 0s, spin); }
}

// After
@include mui-series {
  .my-serie-shake { @include mui-queue(3s, 0s, shake); }
  .my-serie-spin  { @include mui-queue(3s, 0s, spin); }
}

🐛 Safer animation keyframe names for CSS

Fixes a bug when using decimal values for the zoom effect and transition arguments would generate an invalid CSS Keyframes name and break the animation.

We changed the way we validate arguments and generate keyframes in such a way that they will always have a valid CSS name for all effects, transitions and arguments passed in.

🐛 Improved support for new Sass first-hand functions alongside function name strings

In order to improve modular namespacing, Sass 4 will only accepts first-class functions as argument for call() so functions will be called in their own context. This allow developers to make their Sass packages more modular while still being able to call functions given by the user. As a first step, Sass 3.5 added get-function() to get a first-hand function from its name and throw a warning if a function name string is passed to call(). Developers are now encouraged to use get-function(), but this would make their package incompatible to older Sass versions.

We added a set of helpers to support both first-hand function and function name strings in all our functions and mixins in all Sass versions. If you are using Motion UI with Sass >= 3.5, we recommend you to use pass your functions to Motion UI with get-function(...). Otherwise, we may not be able to find them as their were defined in a context we not may have access to.

For more informations, see Making Function Calls Across Sass Versions and Making sense out of Sass 3.5 first-class functions.

📦 jQuery is now a peerDependency

We think that like for most browser packages, you will want to only have one jQuery version installed and to choose its version by yourself. For this reason, jQuery cannot be considered as an internal dependency (like implementation detail) and should be exposed to you as a peerDependency.

We did not include jQuery in the Motion UI JavaScript library before. If you use it, you should already have jQuery imported so Motion UI will work the same way as before.

Note for npm users: you may now have a warning message asking you to install the jquery npm package if you did not have it already. Please do so with a jQuery version that we support: jquery@>=2.2.0.

📄 All changes

• 📖 #94 - Fix parameter name for zoom animation (@cmarchena)
• 🐛 #100 - Fix deprecation warning for Sass 4.0 (@rediris, closes #99)
• 🐛 #102 - Make animation keyframes names safe for CSS (@ncoden, closes #96)
• 🚀 #103 - Make transitions/effects directions depending on in/out state (@ncoden, closes #83)
• 🚀 #108 - Change mui-series paused behavior for better Safari support (@ncoden, closes #97)
• 🐛 #109 - Ensure -mui-keyframe-pct returns a strintg instead of a list (@ncoden, closes #109)
• 📦 #110 - Update development dependencies to latest versions (@ncoden)
• 💻 #111 - Add Travis to run tests on node-sass 3/4/latest (@ncoden)
• 💻 #112 - Ensure support of iOS Safari 7 and drop support for Android browser 2.3 (@ncoden)
• 📖 #114 - Add a CHANGELOG file (@ncoden)
• 📖 #115 - Improve README design and installation instructions (@ncoden)
• 📦 #112 - Move jQuery to peerDependencies (@ncoden)
• 🐛 #117 - Fix support for function name strings for Sass < 3.5 (@ncoden, introduced in #100)

👩‍💻 Contributors

Thank you to the amazing people who contributed to this release:

• Carlos Marchena (@cmarchena)
• Kevin Ball (@kball)
• Nicolas Coden (@ncoden)
• Roman Edirisinghe (@rediris)

Release Checklist

• [x] Bump versions
• [x] Update documentation
• [x] Update dist files
• [x] Update CHANGELOG.md

[ncoden]

Poke @DanielRuf @SassNinja

[ncoden]

Poke @gakimball @kball @DanielRuf. Could you review this ? Thanks !

[DanielRuf]

breaking change

breaking changes

values as defauls

values as defaults

standard animations names are not supported anymore as mui-series queues names

standard animation names are not supported anymore as mui-series queue names

keyframes names for CSS

keyframe names for CSS

Fixes a bug when using decimals values

Fixes a bug when using decimal values

arguments and generate keyframe in such

arguments and generate keyframes in such

as an internal dependency (like implementation detail)and should

as an internal dependency (like implementation detail) and should

We did not included jQuery in the Motion UI Javascript library before.

We did not include jQuery in the Motion UI JavaScript library before.

Rest is good 👍

[ncoden]

@DanielRuf Fixed. Thank you!

[ncoden]

Poke @gakimball. Are you ok with this release ?

[gakimball]

Looks good to me, great work! 👌

[rediris]

Are we ready to merge this?

[ncoden]

@rediris Almost. I still need to merge https://github.com/zurb/motion-ui/pull/117. We introduced an incompatibility with Sass < 3.5 at #100.

[rediris]

@ncoden sounds good. Sorry I didn't account for that!

[ncoden]

Sorry I didn't account for that!

Don't worry.

I merged the latest changes (#117), updated the documentation and the changelog (see above). I think everything is ready 🎉