docs(pull-refresh): enhance doc

varletjs · Mar 3, 2022 · ca60b1a · ca60b1a
1 parent ee5c559
commit ca60b1a
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/packages/varlet-ui/src/pull-refresh/docs/en-US.md b/packages/varlet-ui/src/pull-refresh/docs/en-US.md
@@ -57,6 +57,22 @@ export default {
 }
 ```
 
+### Attention
+
+When the height of the `PullRefresh` is `0`, it will be unavailable, so you need to ensure that the height of its child elements is **not** `0` or set height for the `PullRefresh`:
+
+```html
+<var-pull-refresh>
+  <div style="height: 200px"></div>
+</var-pull-refresh>
+
+// or
+
+<var-pull-refresh style="height: 200px">
+  <div></div>
+</var-pull-refresh>
+```
+
 ## API
 
 ### Props

diff --git a/packages/varlet-ui/src/pull-refresh/docs/zh-CN.md b/packages/varlet-ui/src/pull-refresh/docs/zh-CN.md
@@ -56,6 +56,22 @@ export default {
 }
 ```
 
+### 注意
+
+当 `PullRefresh` 容器高度为 `0` 时会导致下拉功能失效，所以需保证其子元素高度**不为** `0` 或为 `PullRefresh` 容器设置高度:
+
+```html
+<var-pull-refresh>
+  <div style="height: 200px"></div>
+</var-pull-refresh>
+
+// 或
+
+<var-pull-refresh style="height: 200px">
+  <div></div>
+</var-pull-refresh>
+```
+
 ## API
 
 ### 属性