Skip to main content
Atlas is deprecated. Use AI Kit for any new Atlas experiences.
A hook for responding to scroll position changes with callbacks for scrolling down and returning to top.

Usage

Options

Returns

Behavior

  • One-time Trigger: onScrollDown only fires once per scroll session (until returning to top)
  • Top Detection: onScrollTop fires when scroll position returns to 0
  • Passive Listener: Uses passive event listener for better scroll performance
  • Window Fallback: Falls back to window scroll if no element is provided

Example: Show/Hide Header on Scroll

Example: Lazy Load Images on Scroll

Last modified on July 24, 2026