Skip to content

Latest commit

 

History

History
566 lines (345 loc) · 20.1 KB

CHANGELOG.md

File metadata and controls

566 lines (345 loc) · 20.1 KB
Raw

Change Log

4.0.9 - 2021-03-04

Fixed

  • Styles applied using CSSOM don't drop : characters.

4.0.8 - 2021-03-02

Fixed

4.0.7 - 2020-07-15

Fixed

  • Ensure element geometry exists. #437

4.0.6 - 2020-03-15

Fixed

  • Default transition values of none are now correctly ignored. #231

Fixed

4.0.5 - 2018-10-20

Fixed

  • Calling reveal() on the same target breaking animation. #468

4.0.4 - 2018-09-22

Fixed

  • Malformed package.json

4.0.3 - 2018-09-21

Fixed

– options.cleanup is now correctly set to false by default. #457

4.0.2 - 2018-09-11

Fixed

  • Null property assignment regression in mount function. #456

4.0.1 - 2018-09-09

Fixed

  • Noop instances were not correctly unmounting from the DOM. #455
  • Readme links to pricing page no longer 404.

4.0.0 - 2018-08-06

Added

  • ScrollReveal can be enabled/disabled on desktops using options.desktop.
  • The class sr is added to <html> during instantiation when supported. #294
  • height: 100% is added to <body> during instantiation when supported. #298
  • Unused containers are removed from the store, and their event listeners destroyed.
  • ScrollReveal skips generating opacity styles when options.opacity is set to null.
  • ScrollReveal retains element CSS transformations. #251
  • New options.cleanup toggles whether generated styles are removed upon reveal completion (when options.reset is false). #292
  • ScrollReveal tracks scroll direction as container store data. #384
  • New clean() method removes specific generated styles and event listeners. #227
  • New destroy() method removes all generated styles and event listeners. #227
  • New debug static property toggles error messages in console. #351
  • Instance methods now accept native arrays of HTML elements.

Changed

  • Breaking: The reveal() method no longer accepts an interval parameter. Instead, sequence intervals are now defined with options.interval.
  • Breaking: The instance method isSupported() is now static.
  • Breaking: options.distance supports only em px and % values.
  • Breaking: ScrollReveal methods are no longer chainable.
  • Breaking: ScrollReveal requires a commercial license, unless for GPL-3.0 compatible open source projects.
  • Elements in a reveal sequence are no longer grouped, and reveal progressively when visible.
  • ScrollReveal uses a single matrix3d() property, with the correct prefix and only when necessary. #292
  • ScrollReveal returns a non-operational instance when instantiated in unsupported browsers.
  • ScrollReveal version is now a read-only instance property.
  • ScrollReveal methods are now bound read-only instance properties.
  • options.viewFactor clamps values outside of 0.0 to 1.0.
  • ScrollReveal constructor now returns a singleton.

Fixed

  • The requestAnimationFrame polyfill now reliably throttles callback invocations.

3.3.6 - 2017-06-23

Fixed

  • Element visibility now checks left and right boundaries correctly. #352
  • Library version instance property is again accurate.

3.3.5 - 2017-04-05

Fixed

  • Patched to ensure version 3 is the default NPM package.

3.3.4 - 2017-02-18

Fixed

  • Update stale CDN link in README.

Changed

  • Add deprecation warnings to README.

3.3.3 - 2017-02-18

Fixed

  • Fix error when using Bower and Wordpress due to missing semi-colon. #278

3.3.2 - 2016-10-02

Changed

  • Updated Starting Defaults section in README. #273

Fixed

  • Using a selector to define a default container during instantiation now works. #289

3.3.1 - 2016-07-22

Fixed

  • Instance variable version updated with correct library version.

3.3.0 - 2016-07-22

Added

  • New callback beforeReveal(el). #273
  • New callback beforeReset(el). #273

3.2.0 - 2016-07-08

Added

  • New isNodeList() method added to Tools.
  • New version instance variable contains library version.
  • HTML Collections are now supported as the first argument in reveal(). #246
  • Added fallback for requestAnimationFrame. #267

Changed

  • Updated Starting Defaults section in README.

Fixed

  • Calling reveal() multiple times on an element with config.origin as top or left no longer produces invalid CSS. #270
  • Refactored AMD/CommonJS module wrapper to work with Codekit. #253

3.1.5 - 2016-07-06

Fixed

  • sync() method now properly supports sequences.

3.1.4 - 2016-03-28

Changed

  • Added console.log calls back to non-minified distribution. #235

3.1.3 - 2016-03-28

Removed

  • Removed console.log calls from distribution. #235

3.1.2 - 2016-03-23

Fixed

  • Removed stray quotation mark in reveal() error message.

3.1.1 - 2016-03-08

Fixed

  • config.reset now works properly with sequences. #241

3.1.0 - 2016-03-07

Added

  • New isNode() method added to Tools.
  • HTML elements are now supported as the first argument in reveal().
  • Selector strings assigned to config.container are now supported.
  • reveal() now accepts an interval as it's last argument to create sequences. #86 #180 #187 #215 #234
  • New section on sequenced animations added to README.

Changed

  • Messages logged to console are now prepended with ScrollReveal: for clarity.
  • Revised and renamed supported() method to isSupported().
  • Updated Custom Containers section in README with an example using a selector.
  • Updated Tips section in README.

Fixed

  • Added semi-colon before global IIFE to improve reliability. #228
  • The existence of console.log is now confirmed for IE9. #230
  • Typos, indentation and semicolons corrected in README.

3.0.9 - 2016-01-14

Changed

  • Updated example site links in the README.

Fixed

  • Fixed operator mismatch inside supported(). #220

3.0.8 - 2016-01-13

Changed

  • Public methods now verify that ScrollReveal is supported.

Fixed

  • Updated Tips section in README.

3.0.7 - 2016-01-13

Added

  • Added brower support information to README. #219

Changed

  • console.log is now used instead of console.warn. #215
  • Moved tools.isSupported method to ScrollReveal.prototype.supported.
  • Updated the configuration and tips documentation in the README.

Removed

  • The init() method was removed.

Fixed

  • Using config.mobile in reveal() now works. #216

3.0.6 - 2016-01-02

Fixed

  • Custom default containers are now used.
  • Critical issues affecting Chrome on iOS were (finally) solved. #196
  • Revisited 3.0.4 changes to chaining reveal() calls. #212

3.0.5 - 2015-12-30

Fixed

  • Fixed compatibility issues with Webpack. #209

3.0.4 - 2015-12-30

Fixed

  • Squashed Webkit browser bugs due to syntax errors. #208
  • Chaining reveal() calls no longer prematurely initialize animation.
  • Cleaned up README typos, and stale reference to config.wait.

3.0.3 - 2015-12-22

Changed

  • reveal() and sync() now return the ScrollReveal instance even on failure. #198

3.0.2 - 2015-12-22

Added

  • Added bower.json to release package. #199

Fixed

  • Preexisting CSS transition styles are no longer destroyed. #197

3.0.1 - 2015-12-21

Changed

  • Updated Getting Started section in the README.

Fixed

  • Hard learned NPM and Bower issues related to release management were endured.
  • Issues related to element visibility and animation behavior were addressed. #193 #196

3.0.0 - 2015-12-15

This version marks a significant change in how developers use ScrollReveal, introducing a JavaScript API to replace the inline attribute parser. It's a big shift, but prioritizes maintainability and flexibility over the novelty of natural language parsing.

Added

  • New method reveal(). #1 #122
  • New method sync().
  • New callback config.afterReset.
  • Horizontal scrolling is now supported. #184

Changed

  • Breaking: config.enter renamed config.origin.
  • Breaking: config.wait renamed config.delay.
  • Breaking: config.delay renamed config.useDelay.
  • Breaking: config.over renamed config.duration.
  • Breaking: config.move renamed config.distance.
  • Breaking: config.viewport renamed config.container.
  • Breaking: config.vFactor renamed config.viewFactor.
  • Breaking: config.complete renamed config.afterReveal.
  • Breaking: Time values are now expected in milliseconds (instead of string).
  • Breaking: config.scale expects value type number (instead of object).
  • Breaking: config.rotation axis values require string with unit type (instead of number).
  • Breaking: ScrollReveal constructor is now capitalized.
  • Reveals now resolve to element's computed opacity, instead of 1. #185

Removed

  • ScrollReveal no longer recognizes data-sr attributes.

Fixed

  • Improved reliability of callback timers.

2.3.2 - 2015-06-15

Changed

  • Updated bower.json syntax. #150

2.3.1 - 2015-06-04

Added

  • Simple instantiation (without new keyword) is now supported. #148

2.3.0 - 2015-04-25

Added

  • New keyword vFactor and alias vF control when an element is considered visible.
  • New keyword opacity controls starting opacity.

Removed

  • The easing keyword hustle was removed.

2.2.0 - 2015-03-18

Added

  • New keyword spin controls yaw.
  • New keyword roll controls roll.
  • New keyword flip controls pitch.

Changed

  • Improved Basic Usage examples in README.

2.1.0 - 2014-11-25

Added

  • Various tablets added to mobile device detection. #32 #81
  • CSS Transition support is now confirmed during instantiation. #109

2.0.5 - 2014-11-23

Changed

  • Reverted 2.0.4 change to element animation logic. #108

2.0.4 - 2014-11-21

Changed

  • Revised how element animations are handled.
  • Reverted 2.0.3 change to element visibility logic. #106

2.0.3 - 2014-11-14

Added

  • data-sr attributes are now stripped from initialized elements. #100 @orapouso.
  • Live Reload added to development environment.

Changed

  • Revised how element visibility is determined.

Removed

  • Multiple instances sharing the same viewport element no longer throw an error. #98 @orapouso.

Fixed

  • Incomplete support for config.delay = "onload" was addressed.
  • Issues related to setTimeout, config.complete and incorrect animation timing were addressed. #96

2.0.2 - 2014-10-23

Added

  • An error is now thrown when multiple instances share the same viewport element. #91

Fixed

  • Updated NPM and Bower references with new distribution path.

2.0.1 - 2014-10-18

Fixed

  • Incomplete support for config.viewport was addressed. #67 #68

2.0.0 - 2014-10-17

Added

  • New keyword scale controls element starting size.
  • New option config.complete defines a callback for when reveals finish.
  • New option config.viewport defines custom viewports.
  • New option config.mobile enables/disables ScrollReveal on mobile devices.
  • New option config.delay controls when animations are delayed.

Changed

  • BREAKING: ScrollReveal now uses the data-sr instead of data-scroll-reveal.
  • Repository now follows Semantic Versioning.

Removed

  • The after keyword was removed.

0.1.3 - 2014-05-26 [YANKED]

Added

  • Configuration now includes starting opacity. #33 @kierzniak
  • New data-scroll-reveal-id attribute added to revealed DOM elements.

Changed

  • Scroll event handling now uses requestAnimationFrame. #48 @pazguille
  • Generated styles are now stored in an object corresponding to the data-scroll-reveal-id attribute on each element. #38 @georgelee1

0.1.2 - 2014-03-13 [YANKED]

Added

  • Elements with position: fixed are now supported. #35

Fixed

  • Generated styles are now more specific. #37

0.1.1 - 2014-03-06 [YANKED]

Fixed

  • Squashed bug with enter top and enter left. #13 #31 @sherban @danycerone

0.1.0 - 2014-03-05 [YANKED]

Added

  • Distribution now supports AMD/CommonJS.
  • Repository now uses Gulp.
  • Boilerplate Testline suite added to repository.

Changed

  • BREAKING: ScrollReveal now uses the data-scroll-reveal attribute to parse animation instructions, in place of data-scrollReveal.

0.0.4 - 2014-02-28 [YANKED]

Fixed

  • ScrollReveal no longer destroys the existing style attribute on revealed elements, but instead, now appends the necessary animation styles to existing inline styles.

0.0.3 - 2014-02-22 [YANKED]

Fixed

  • Removed unused CSS Transition/Transform prefixes for Mozilla and Opera.

0.0.2 - 2014-02-13 [YANKED]

Added

  • Constructor now accepts a configuration object to customize defaults.
  • New reset keyword allows elements to reveal each time they enter the viewport.
  • The move keyword can now be replaced with with CSS easing keywords (e.g. ease-in-out).
  • Library documentation and code examples added to README.

Changed

  • ScrollReveal is no longer automatically instantiated by the DOMContentLoaded event.

0.0.1 - 2014-01-22 [YANKED]

Hello World