From 90669560a413c770315fd0e2ba1054ef11fb7c82 Mon Sep 17 00:00:00 2001
From: chenjiahan <chenjiahan@youzan.com>
Date: Mon, 5 Oct 2020 08:53:13 +0800
Subject: [PATCH] docs(@vant/use): add useToggle doc

---
 packages/vant-use/.vuepress/config.js         |  7 ++-
 .../vant-use/src/usePageVisibility/README.md  |  6 +-
 .../vant-use/src/useScrollParent/README.md    |  6 +-
 packages/vant-use/src/useToggle/README.md     | 62 +++++++++++++++++++
 4 files changed, 74 insertions(+), 7 deletions(-)
 create mode 100644 packages/vant-use/src/useToggle/README.md

diff --git a/packages/vant-use/.vuepress/config.js b/packages/vant-use/.vuepress/config.js
index 54275a929..687d3697c 100644
--- a/packages/vant-use/.vuepress/config.js
+++ b/packages/vant-use/.vuepress/config.js
@@ -12,10 +12,15 @@ module.exports = {
     ],
     sidebarDepth: 0,
     sidebar: [
+      {
+        title: '介绍',
+        collapsable: false,
+        children: ['/'],
+      },
       {
         title: 'State',
         collapsable: false,
-        // children: ['/src/useToggle/'],
+        children: ['/src/useToggle/'],
       },
       {
         title: 'DOM',
diff --git a/packages/vant-use/src/usePageVisibility/README.md b/packages/vant-use/src/usePageVisibility/README.md
index e3b552dd7..8af5a42c9 100644
--- a/packages/vant-use/src/usePageVisibility/README.md
+++ b/packages/vant-use/src/usePageVisibility/README.md
@@ -33,6 +33,6 @@ type VisibilityState = 'visible' | 'hidden';
 
 ### 返回值
 
-| 参数 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| visibilityState | 页面当前的可见状态，`visible` 为可见，`hidden` 为隐藏 | _Ref\<VisibilityState>_ | - |
+| 参数 | 说明 | 类型 |
+| --- | --- | --- |
+| visibilityState | 页面当前的可见状态，`visible` 为可见，`hidden` 为隐藏 | _Ref\<VisibilityState>_ |
diff --git a/packages/vant-use/src/useScrollParent/README.md b/packages/vant-use/src/useScrollParent/README.md
index 32046e810..cf6ef674d 100644
--- a/packages/vant-use/src/useScrollParent/README.md
+++ b/packages/vant-use/src/useScrollParent/README.md
@@ -48,6 +48,6 @@ function useScrollParent(element: Ref<Element>): Ref<Element>;
 
 ### 返回值
 
-| 参数         | 说明               | 类型            | 默认值 |
-| ------------ | ------------------ | --------------- | ------ |
-| scrollParent | 最近的可滚动父元素 | _Ref\<Element>_ | -      |
+| 参数         | 说明               | 类型            |
+| ------------ | ------------------ | --------------- |
+| scrollParent | 最近的可滚动父元素 | _Ref\<Element>_ |
diff --git a/packages/vant-use/src/useToggle/README.md b/packages/vant-use/src/useToggle/README.md
new file mode 100644
index 000000000..5a7ff423d
--- /dev/null
+++ b/packages/vant-use/src/useToggle/README.md
@@ -0,0 +1,62 @@
+# useToggle
+
+用于在 `true` 和 `false` 之间进行切换。
+
+## 代码演示
+
+### 基本用法
+
+```js
+import { useToggle } from '@vant/use';
+
+export default {
+  setup() {
+    const [state, toggle] = useToggle();
+
+    toggle(true);
+    console.log(state.value); // -> true
+
+    toggle(false);
+    console.log(state.value); // -> false
+
+    toggle();
+    console.log(state.value); // -> true
+  },
+};
+```
+
+### 设置默认值
+
+```js
+import { useToggle } from '@vant/use';
+
+export default {
+  setup() {
+    const [state, toggle] = useToggle(true);
+    console.log(state.value); // -> true
+  },
+};
+```
+
+## API
+
+### 类型定义
+
+```ts
+function useToggle(
+  defaultValue: boolean
+): [Ref<boolean>, (newValue: boolean) => void];
+```
+
+### 参数
+
+| 参数         | 说明   | 类型      | 默认值  |
+| ------------ | ------ | --------- | ------- |
+| defaultValue | 默认值 | _boolean_ | `false` |
+
+### 返回值
+
+| 参数   | 说明             | 类型                           |
+| ------ | ---------------- | ------------------------------ |
+| state  | 状态值           | _Ref\<boolean>_                |
+| toggle | 切换状态值的函数 | _(newValue?: boolean) => void_ |