/** based on framer-motion@4.1.17, Copyright (c) 2018 Framer B.V. */ import type { ScrollMotionValues } from './utils.js'; /** * Returns MotionValues that update when the viewport scrolls: * * - `scrollX` — Horizontal scroll distance in pixels. * - `scrollY` — Vertical scroll distance in pixels. * - `scrollXProgress` — Horizontal scroll progress between `0` and `1`. * - `scrollYProgress` — Vertical scroll progress between `0` and `1`. * * **Warning:** Setting `body` or `html` to `height: 100%` or similar will break the `Progress` * values as this breaks the browser's capability to accurately measure the page length. * * @motion * * ```jsx * export const MyComponent = () => { * const { scrollYProgress } = useViewportScroll() * return * } * ``` * * @public */ export declare function useViewportScroll(): ScrollMotionValues; //# sourceMappingURL=use-viewport-scroll.d.ts.map