Skip to content

Latest commit

 

History

History
57 lines (51 loc) · 4.74 KB

CHANGELOG.md

File metadata and controls

57 lines (51 loc) · 4.74 KB
Raw

CHANGELOG

1.1.0 (2014-09-04)

potentially breaking changes:

  • zero duration scene events & states
    The event logic for zero duration scenes has been changed: From now on a zero duration scene will trigger enter, start, progress (in this order) when scrolling forward past the trigger point and progress, start, leave when scrolling in reverse.
    This means there will never be an end event triggered, which reflects the behaviour more accurately.
    Furthemore this affects the scene's possible states, which can now only be "BEFORE" and "DURING" for zero duration scenes.
    To learn more, read this issue or this documentation.
  • removed method startPosition()
    Method was marked deprecated since v1.0.7 and has now been replaced by triggerPosition().
    The terms "offset" and "position" were used too randomly.
    To avoid confision, from now on "offset" will be used in connection with the scroll offset of the container, while "position" refers to the top / left values within the DOM.
  • change event only fires when change actually happened
    If a setter is used with the current value or the internal validator fails and defaults to the same value an option is already set to, no change event will be fired anymore.

non-breaking changes

  • scenes are sorted in controller
    Scenes attached to the same controller are now updated in the order of their start position.
    This way DOM modifcations (e.g. tweens) that influence each other are sure to be called in the right order.
    To learn more, read this issue.
  • marked triggerOffset as deprecated, replaced by triggerPosition
    Renaming to avoid confusion. Read above for clarification.
  • new controller option refreshInterval
    To update values that otherwise wouldn't fire an event a refreshInterval option was added to poll for changes.
    These changes involve resizing of a div scroll container or movement of a scene's trigger element position.
  • no more logging in minified version
    All debug logging functionality was removed when using the minified version to save on filesize.

features:

  • new controller method: scrollTo
  • new controller method: scrollPos
  • new scene method: refresh
  • new scene method: setClassToggle, removeClassToggle respectively
  • new scene event: shift fires when scene position changes
  • new scene event: destroy fires when scene is destroyed
  • extended scene option duration to support dynamic updates in responsive layouts
  • docs: grouped methods for more clear arrangement
  • docs: various additions and clarifications

bugfixes:

  • removing and resetting pins during pin phase didn't work properly
  • using mousewheel to scroll over pinned elements in container (See issues 34, 50, 82, 139, 140)
  • pin width collapsed, if no width was defined (See issues 63, 94)
  • positioned pins didn't work in IE 9
  • padding of pinned elements was added to relative width
  • event namespace issues
  • docs: fixed highlight & deeplink issues

examples: