[3.0.0] - 2020-06-22

Breaking changes

• scrollToBottom/scrollToEnd/scrollToStart/scrollToTop now accept an option { behavior: 'auto' | 'smooth' }
  • Without the option, it is by default to artificial smooth scrolling (smooth), to keep existing behavior
  • This behavior may change in the future, by defaulting to discrete scrolling (auto), to better align with HTML DOMElement.scrollIntoView standard
  • During the transition, please always pass { behavior: 'smooth' } to keep existing behavior

Changed

• Bump dependencies, in PR #50
  • @babel/cli@7.10.3
  • @babel/core@7.10.3
  • @babel/plugin-proposal-object-rest-spread@7.10.3
  • @babel/preset-env@7.10.3
  • @babel/preset-react@7.10.1
  • eslint@7.3.0
  • eslint-plugin-prettier@3.1.4
  • eslint-plugin-react@7.20.0
  • eslint-plugin-react-hooks@4.0.4

Added

• Added version number to <meta name="react-scroll-to-bottom:version"> for diagnostic purpose, in PR #51
• Added useAnimatingToEnd getter to indicate if it is animating towards to the end, in PR #49
  • The existing useAnimating getter only indicate if it is animating to any scroll positions
• Added scrollTo function to scroll to a specific scrollTop value, this is similar to DOMElement.scrollIntoView(), in PR #49
  • The signature is scrollTo(scrollTop: number, options: { behavior: 'auto' | 'smooth' })
  • Pass { behavior: 'smooth' } for synthetic smooth scrolling
• Added useObserveScrollTop hook to observe scroll event, in PR #49
  • This effect function will be called rapidly on scroll, please avoid expensive code such as calling setter of useState and any code that would cause re-render

Fixed

• Cancel scroll animation on mouse wheel or touch gesture, in PR #49
• Calling scrollTo should cancel any existing scroll animation, in PR #49