Browse Source

Merge branch 'v2' of https://github.com/jdf2e/nutui into v2

Frans 7 years ago
parent
commit
92e1eaa5aa
2 changed files with 9 additions and 5 deletions
  1. 8 4
      src/packages/backtop/doc.md
  2. 1 1
      src/packages/rate/doc.md

+ 8 - 4
src/packages/backtop/doc.md

@@ -1,11 +1,12 @@
-# Switch 滑动开关
+# BackTop 回到顶部
 
 用于较长的页面快捷回到顶部的组件。
 
 ## 基本用法
 
 ```html
-<nut-backtop></nut-backtop>
+<nut-backtop>
+</nut-backtop>
 ```
 
 ## 设置出现位置
@@ -15,9 +16,12 @@
   :distance="400"
 >
 </nut-backtop>
+```
+
 > “页面垂直方向滚动高度”后出现
 
 ## click事件
+
 ```html
 <nut-backtop 
   @click="onClick"
@@ -60,12 +64,12 @@ export default {
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
 | duration | 设置动画持续时间 | Number | 1000
-| distance | 设置“页面垂直方向滚动高度”后出现 | Number | 200
+| distance | “页面垂直方向滚动高度”后出现 | Number | 200
 | bottom | 设置离页面底部距离 | Number | 30
 | right | 设置离页面右边距离 | Number | 30
 | zIndex | 设置层级 | Number | 1111
 
-## Events
+## Event
 | 字段 | 说明 | 回调参数 
 |----- | ----- | ----- 
 | click | 按钮点击时触发 | -

+ 1 - 1
src/packages/rate/doc.md

@@ -47,7 +47,7 @@
 | uncheckedIcon | 使用图标(未选中) | String | -
 | checkedIcon | 使用图标(选中) | String | -
 
-## Events
+## Event
 | 字段 | 说明 | 回调参数 
 |----- | ----- | ----- 
 | click | 点击star市触发 | star的index