useClickAway

Intro

Triggers a callback when user clicks outside of the target element.

Usage

Basic Usage

<div ref="root" />

import { ref } from 'vue';
import { useClickAway } from '@vant/use';

export default {
  setup() {
    const root = ref();
    useClickAway(root, () => {
      console.log('click outside!');
    });

    return { root };
  },
};

Custom Event

<div ref="root" />

import { ref } from 'vue';
import { useClickAway } from '@vant/use';

export default {
  setup() {
    const root = ref();
    useClickAway(
      root,
      () => {
        console.log('touch outside!');
      },
      { eventName: 'touchstart' },
    );

    return { root };
  },
};

API

Type Declarations

type Options = {
  eventName?: string;
};

function useClickAway(
  target:
    | Element
    | Ref<Element | undefined>
    | Array<Element | Ref<Element | undefined>>,
  listener: EventListener,
  options?: Options,
): void;

Params

Name	Description	Type	Default Value
target	Target element, support multiple elements	Element | Ref<Element> | Array<Element | Ref<Element>>	-
listener	Callback function when the outside is clicked	EventListener	-
options	Options	Options	{ eventName: 'click' }

Options

Name	Description	Type	Default Value
eventName	Event name	string	click