asscroll v2.0.0 Release Notes

Release Date: 2021-05-06 // 9 months ago
  • ๐Ÿš€ This release includes some breaking changes - see "Updated" below.

    • โœ‚ Removed support for IE11 and updated targeted browser compatibility, resulting in a package size reduction of over 30%
    • โž• Added JSDoc to enable auto-completion and type-hinting. This is also used to generate accurate README documentation
    • ๐ŸŽ The check to determine screen refresh rate only runs briefly after initialising ASScroll, stopping continuous calls to performance.now() thus slightly increasing performance

    ๐Ÿ†• New

    • The container element and scroll element(s) can now be sent to ASScroll as HTMLElement / NodeList meaning you can pre-select rather than make ASScroll select them again via document.querySelector() (#47)
    • ๐Ÿ”ฆ Exposed maxScroll, containerElement, scrollElements and isHorizontal
    • โž• Added scrollEnd event which fires when the lerped scroll position reaches its target
    • โž• Added example to show how ASScroll works with PJAX navigation
    • โž• Added example showing ASScroll + DOM/WebGL syncing

    โšก๏ธ Updated

    • ๐Ÿ‘ ASScroll.scrollPos and ASScroll.smoothScrollPos have been renamed to ASScroll.targetPos and ASScroll.currentPos respectively. This is to better represent what these values mean
    • ASScroll.targetPos and ASScroll.currentPos now return positive values rather than the negative Y translate value used to transform the scroll element(s). This should make it more intuitive when using these values in your own code
    • โšก๏ธ ASScroll.onRaf() and ASScroll.onResize() have been renamed to ASScroll.update() and ASScroll.resize() respectively
    • ASScroll.enable() and ASScroll.disable() now accept an object as their parameter so you can pass only the options you need to
    • The element and innerElement options have been renamed to containerElement and scrollElements respectively
    • ๐Ÿ‘€ The disableOnTouch option has been renamed to touchScrollType - see docs for more info

    ๐Ÿ›  Fixed

    • Scrollbar did not match the mouse position when dragging which caused scroll jumps (#12)
    • 0๏ธโƒฃ Using <script> tags to include the library meant having to reference ASScroll.default in order to access the class (#46)
    • Scroll position and max height values were not previously reporting the correct values on touch devices