From 659ccc7a817ca8f8ac468fba9c8c511d46cb1c8d Mon Sep 17 00:00:00 2001 From: chenjiahan Date: Sun, 4 Oct 2020 19:46:14 +0800 Subject: [PATCH] docs(@vant/use): adjust strcut --- packages/vant-use/src/useClickAway/README.md | 8 +++++--- packages/vant-use/src/useEventListener/README.md | 6 ++++-- packages/vant-use/src/usePageVisibility/README.md | 6 ++++-- packages/vant-use/src/useScrollParent/README.md | 8 +++++--- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/packages/vant-use/src/useClickAway/README.md b/packages/vant-use/src/useClickAway/README.md index ef9ac4fee..2e5df9937 100644 --- a/packages/vant-use/src/useClickAway/README.md +++ b/packages/vant-use/src/useClickAway/README.md @@ -54,7 +54,9 @@ export default { }; ``` -## 类型定义 +## API + +### 类型定义 ```ts function useClickAway( @@ -68,7 +70,7 @@ type Options = { }; ``` -## 参数 +### 参数 | 参数 | 说明 | 类型 | 默认值 | | -------- | ------------------------ | -------------------------- | ------ | @@ -76,7 +78,7 @@ type Options = { | listener | 点击外部时触发的回调函数 | _EventListener_ | - | | options | 可选的配置项 | _Options_ | 见下表 | -## Options +### Options | 参数 | 说明 | 类型 | 默认值 | | --------- | -------------- | -------- | ------- | diff --git a/packages/vant-use/src/useEventListener/README.md b/packages/vant-use/src/useEventListener/README.md index 72942730f..3d6bf7468 100644 --- a/packages/vant-use/src/useEventListener/README.md +++ b/packages/vant-use/src/useEventListener/README.md @@ -46,7 +46,9 @@ type Options = { }; ``` -## 参数 +## API + +### 参数 | 参数 | 说明 | 类型 | 默认值 | | -------- | ------------------------ | --------------- | ------ | @@ -54,7 +56,7 @@ type Options = { | listener | 点击外部时触发的回调函数 | _EventListener_ | - | | options | 可选的配置项 | _Options_ | - | -## Options +### Options | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | diff --git a/packages/vant-use/src/usePageVisibility/README.md b/packages/vant-use/src/usePageVisibility/README.md index 1afded4fa..e3b552dd7 100644 --- a/packages/vant-use/src/usePageVisibility/README.md +++ b/packages/vant-use/src/usePageVisibility/README.md @@ -21,7 +21,9 @@ export default { }; ``` -## 类型定义 +## API + +### 类型定义 ```ts function usePageVisibility(): Ref; @@ -29,7 +31,7 @@ function usePageVisibility(): Ref; type VisibilityState = 'visible' | 'hidden'; ``` -## 返回值 +### 返回值 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | diff --git a/packages/vant-use/src/useScrollParent/README.md b/packages/vant-use/src/useScrollParent/README.md index 85f3934b8..32046e810 100644 --- a/packages/vant-use/src/useScrollParent/README.md +++ b/packages/vant-use/src/useScrollParent/README.md @@ -32,19 +32,21 @@ export default { }; ``` -## 类型定义 +## API + +### 类型定义 ```ts function useScrollParent(element: Ref): Ref; ``` -## 参数 +### 参数 | 参数 | 说明 | 类型 | 默认值 | | ------- | -------- | --------------- | ------ | | element | 当前元素 | _Ref\_ | - | -## 返回值 +### 返回值 | 参数 | 说明 | 类型 | 默认值 | | ------------ | ------------------ | --------------- | ------ |