Skip to content

2.0.0

Compare
Choose a tag to compare
@ganderzz ganderzz released this 03 Nov 17:37
· 101 commits to master since this release
8a2e91e

Introducing a new API for React-Scroll-To that'll allow more flexibility!

#56

Notable features:

  • Added the ability to scroll by a ref object
  • Added the ability to smooth scroll
  • Added cleaner destructuring in render props
  • Updated scroll and scrollById functions to be a singular scrollTo function
  • scrollTo() not accepts an object that allows some fields to be left out (No longer need to include the 'x' position if we're only scrolling by 'y')
  • Added Storybook docs to visualize and test features

Example:

scrollTo({
  x: 25 // The horizontal x position to scroll to
  y: 10 // The vertical y position to scroll to
  id: "myId" // The ID of the ScrollArea we want to scroll
  ref: refObj // A reference to a component to scroll
  smooth: true // If true, this will animate the scroll to be smooth. False will give an instant scroll. (defaults: false)
});