Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 563 Bytes

useScroll.md

File metadata and controls

31 lines (24 loc) · 563 Bytes

useScroll

Vue sensor hook that re-renders when the scroll position in a DOM element changes.

Usage

import {useScroll, useRef} from 'vue-next-use';

const Demo = {
  setup(){
      const scrollRef = useRef(null);
      const state = useScroll(scrollRef);

      return () => {
          const {x, y} = state;
          return (
              <div ref={scrollRef}>
                  <div>x: {x}</div>
                  <div>y: {y}</div>
              </div>
          )};
  }
};

Reference

useScroll(ref: RefObject<HTMLElement>);