# All files / src/_hooks Scroll.ts

100% Statements 6/6
100% Branches 2/2
100% Functions 1/1
100% Lines 3/3

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    286x

    21x
    21x

     import {
      Config as EventListenerConfig,
      useEventListener,
    } from './EventListener'

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export interface UseScrollConfig {
      /**
       * @since 10.19.0
       */
      onScroll: EventListenerConfig['handler']
      /**
       * @since 10.19.0
       */
      scope?: EventListenerConfig['scope']
    }

    /**
     * @deprecatedSince 9
     * @deprecated Never officially documented/supported
     */
    export function useScroll({ onScroll, scope = window }: UseScrollConfig) {
      return useEventListener({ event: 'scroll', handler: onScroll, scope })
    }