From 8089eefa203ed21e17232f221ce8d8c5fe790ffa Mon Sep 17 00:00:00 2001
From: neverland <chenjiahan@youzan.com>
Date: Thu, 10 Jun 2021 19:45:33 +0800
Subject: [PATCH] docs: translate useClickAway (#8848)

---
 docs/markdown/use-click-away.en-US.md | 85 +++++++++++++++++++++++++++
 docs/markdown/vant-use-intro.en-US.md |  1 +
 2 files changed, 86 insertions(+)
 create mode 100644 docs/markdown/use-click-away.en-US.md

diff --git a/docs/markdown/use-click-away.en-US.md b/docs/markdown/use-click-away.en-US.md
new file mode 100644
index 000000000..32ec70cd8
--- /dev/null
+++ b/docs/markdown/use-click-away.en-US.md
@@ -0,0 +1,85 @@
+# useClickAway
+
+### Intro
+
+Triggers a callback when user clicks outside of the target element.
+
+## Usage
+
+### Basic Usage
+
+```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 };
+  },
+};
+```
+
+### Custom Event
+
+```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
+
+### Type Declarations
+
+```ts
+type Options = {
+  eventName?: string;
+};
+
+function useClickAway(
+  target: Element | Ref<Element | undefined>,
+  listener: EventListener,
+  options?: Options
+): void;
+```
+
+### Params
+
+| Name | Description | Type | Default Value |
+| --- | --- | --- | --- |
+| target | Target element | _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`       |
diff --git a/docs/markdown/vant-use-intro.en-US.md b/docs/markdown/vant-use-intro.en-US.md
index 83057db6b..5797982c7 100644
--- a/docs/markdown/vant-use-intro.en-US.md
+++ b/docs/markdown/vant-use-intro.en-US.md
@@ -19,5 +19,6 @@ console.log(height.value); // -> window height
 
 | Name | Description |
 | --- | --- |
+| [useClickAway](#/en-US/use-click-away) | Triggers a callback when user clicks outside of the target element |
 | [useCountDown](#/en-US/use-count-down) | Used to manage the countdown |
 | [useToggle](#/en-US/use-toggle) | Used to switch between `true` and `false` |