docs: migrate vant-use document to vant

2021-06-04 17:55:21 +08:00
parent 6128434e22
commit 2fa7b10b35
10 changed files with 67 additions and 6 deletions
@@ -1,85 +0,0 @@
-# useClickAway
-
-监听点击元素外部的事件。
-
-## 代码演示
-
-### 基本用法
-
-```html
-<div ref="root" />
-```
-
-```js
-import { ref } from 'vue';
-import { useClickAway } from '@vant/use';
-
-export default {
-  setup() {
-    const root = ref();
-    useClickAway(root, () => {
-      console.log('click outside!');
-    });
-
-    return { root };
-  },
-};
-```
-
-### 自定义事件
-
-通过 `eventName` 选项可以自定义需要监听的事件类型。
-
-```html
-<div ref="root" />
-```
-
-```js
-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
-
-### 类型定义
-
-```ts
-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` |