vant/packages/vant/docs/markdown/use-scroll-parent.en-US.md

useScrollParent

Intro

Get the closest parent element that is scrollable.

Usage

Basic Usage

<div ref="root" />

import { ref, watch } from 'vue';
import { useScrollParent, useEventListener } from '@vant/use';

export default {
  setup() {
    const root = ref();
    const scrollParent = useScrollParent(root);

    useEventListener(
      'scroll',
      () => {
        console.log('scroll');
      },
      { target: scrollParent },
    );

    return { root };
  },
};

API

Type Declarations

function useScrollParent(
  element: Ref<Element | undefined>,
): Ref<Element | Window | undefined>;

Params

Name	Description	Type	Default Value
element	The current element	Ref<Element>	-

Return Value

Name	Description	Type
scrollParent	The closest parent element that is scrollable	Ref<Element>