import{o as a,a as t,y as n}from"./vue-libs.b44bc779.js";const e={class:"van-doc-markdown-body"},l=n(`

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

NameDescriptionTypeDefault Value
elementThe current elementRef<Element>-

Return Value

NameDescriptionType
scrollParentThe closest parent element that is scrollableRef<Element>
`,8),c=[l],i={__name:"use-scroll-parent.en-US",setup(r,{expose:s}){return s({frontmatter:{}}),(o,d)=>(a(),t("div",e,c))}};export{i as default};