useWindowScroll

Category

Export Size

555 B

Last Changed

2 months ago

Reactive window scroll

Usage

import { useWindowScroll } from '@vueuse/core'

const { x, y } = useWindowScroll()

Type Declarations

/**
 * Reactive window scroll.
 *
 * @see https://vueuse.org/useWindowScroll
 * @param options
 */
export declare function useWindowScroll({ window }?: ConfigurableWindow): {
  x: Ref<number>
  y: Ref<number>
}
export type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>

Source

Source • Demo • Docs

© 2019-present Anthony Fu
Licensed under the MIT License.
https://vueuse.org/core/useWindowScroll/