Vant3 中文入门教程 Vant3 useClickAway

2024-02-25 开发教程 Vant3 中文入门教程 匿名 2

介绍

监听点击元素外部的事件。

代码演示

基本用法

<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 };
},
};

自定义事件

通过 eventName 选项可以自定义需要监听的事件类型。

<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 Options = {
eventName?: string;
};
function useClickAway(
target: Element | Ref<Element | undefined>,
listener: EventListener,
options?: Options
): void;

参数

参数说明类型默认值
target绑定事件的元素Element | Ref<Element> -
listener点击外部时触发的回调函数EventListener -
options可选的配置项Options 见下表

Options

参数说明类型默认值
eventName监听的事件类型string click