Browse Source

fix: 文档修复

Drjnigfubo 3 years ago
parent
commit
7933f9e8b4

+ 9 - 9
src/packages/__VUE/addresslist/doc.en-US.md

@@ -254,15 +254,15 @@ export default {
 
 | Event              | Description                  | Arguments         | Remark               |
 | ------------------ | ---------------------------- | ----------------- | ------------------ |
-| handelDelIcon      | Click the delete icon        | event: Event,item | public               |
-| handelEditIcon     | Click the edit icon          | event: Event,item | public               |
-| handelDelIcon      | Click the delete icon        | event: Event,item | public               |
-| handelItem         | Click on each item in the address list | event: Event,item | public     |
-| addAddressClick    | Click the Add Address button at the bottom | event: Event   | public |
-| longPressCopyClick | Click the Copy Address button      | event: Event,item | Click event under long press function |
-| longPressSetClick  | Click the Set Default button       | event: Event,item | Click event under long press function  |
-| longPressDelClick  | Click the Delete Address button    | event: Event,item | Click event under long press function |
-| swipeDelClick      | Default right swipe delete button  | event: Event,item | Click event under swipe function |
+| handel-del-icon      | Click the delete icon        | event: Event,item | public               |
+| handel-edit-icon     | Click the edit icon          | event: Event,item | public               |
+| handel-del-icon      | Click the delete icon        | event: Event,item | public               |
+| handel-item         | Click on each item in the address list | event: Event,item | public     |
+| add-address-click    | Click the Add Address button at the bottom | event: Event   | public |
+| long-press-copy-click | Click the Copy Address button      | event: Event,item | Click event under long press function |
+| long-press-set-click  | Click the Set Default button       | event: Event,item | Click event under long press function  |
+| long-press-del-click  | Click the Delete Address button    | event: Event,item | Click event under long press function |
+| swipe-del-click      | Default right swipe delete button  | event: Event,item | Click event under swipe function |
 
 ### Slots
 

+ 9 - 9
src/packages/__VUE/addresslist/doc.md

@@ -256,15 +256,15 @@ export default {
 
 | 事件名             | 说明                 | 回调参数          | 备注               |
 | ------------------ | -------------------- | ----------------- | ------------------ |
-| handelDelIcon      | 点击删除图标         | event: Event,item | 公共               |
-| handelEditIcon     | 点击编辑图标         | event: Event,item | 公共               |
-| handelDelIcon      | 点击删除图标         | event: Event,item | 公共               |
-| handelItem         | 点击地址列表每一项   | event: Event,item | 公共               |
-| addAddressClick    | 点击底部添加地址按钮 | event: Event      | 公共               |
-| longPressCopyClick | 点击复制地址按钮     | event: Event,item | 长按功能下点击事件 |
-| longPressSetClick  | 点击设置默认按钮     | event: Event,item | 长按功能下点击事件 |
-| longPressDelClick  | 点击删除地址按钮     | event: Event,item | 长按功能下点击事件 |
-| swipeDelClick      | 默认右滑删除按钮     | event: Event,item | 滑动功能下点击事件 |
+| handel-del-icon      | 点击删除图标         | event: Event,item | 公共               |
+| handel-edit-icon     | 点击编辑图标         | event: Event,item | 公共               |
+| handel-del-icon      | 点击删除图标         | event: Event,item | 公共               |
+| handel-item         | 点击地址列表每一项   | event: Event,item | 公共               |
+| add-address-click    | 点击底部添加地址按钮 | event: Event      | 公共               |
+| long-press-copy-click | 点击复制地址按钮     | event: Event,item | 长按功能下点击事件 |
+| long-press-set-click  | 点击设置默认按钮     | event: Event,item | 长按功能下点击事件 |
+| long-press-del-click  | 点击删除地址按钮     | event: Event,item | 长按功能下点击事件 |
+| swipe-del-click      | 默认右滑删除按钮     | event: Event,item | 滑动功能下点击事件 |
 
 ### Slots
 

+ 2 - 2
src/packages/__VUE/audio/doc.en-US.md

@@ -228,10 +228,10 @@ export default {
 
 | Attribute            | Description               | CallBack   |
 |--------|----------------|--------------|
-| fastBack  | Emitted when audio back | play time(millisecond) |
+| fast-back  | Emitted when audio back | play time(millisecond) |
 | forward  | Emitted when audio forward | play time(millisecond) |
 | play  | Emitted when audio play or pause | play status |
 | ended  | Emitted when audio ended | —— |
 | mute  | Emitted when audio mute | —— |
-| changeProgress  | Emitted when audio progress change | play time(millisecond) |
+| change-progress  | Emitted when audio progress change | play time(millisecond) |
 | can-play `v3.2.0` | Emitted when the user agent can play the media | `event: Event` |

+ 2 - 2
src/packages/__VUE/audio/doc.md

@@ -228,12 +228,12 @@ export default {
 
 | 事件名 | 说明           | 回调参数     |
 |--------|----------------|--------------|
-| fastBack  | 触发语音快退 | 返回当前播放时长(单位:毫秒) |
+| fast-back  | 触发语音快退 | 返回当前播放时长(单位:毫秒) |
 | forward  | 触发语音快进 | 返回当前播放时长(单位:毫秒) |
 | play  | 触发播放/暂停语音 | 返回当前播放状态 |
 | ended  | 语音播放完成,当loop设置为false时生效 | —— |
 | mute  | 触发静音 | —— |
-| changeProgress  | 当进度条改变时触发 | 返回当前播放时长(单位:毫秒) |
+| change-progress  | 当进度条改变时触发 | 返回当前播放时长(单位:毫秒) |
 | can-play `v3.2.0` | 当可以播放媒体文件时触发 | `event: Event` |
 
     

+ 3 - 1
src/packages/__VUE/comment/doc.md

@@ -15,7 +15,9 @@ import { Comment,Icon,Rate } from '@nutui/nutui';
 import { Comment,Icon,Rate } from '@nutui/nutui-taro';
 
 const app = createApp();
-app.use(Comment).use(Icon).use(Rate);
+app.use(Comment);
+app.use(Icon);
+app.use(Rate);
 
 ```
 

+ 3 - 3
src/packages/__VUE/ellipsis/doc.en-US.md

@@ -15,7 +15,7 @@ import { Ellipsis } from '@nutui/nutui';
 import { Ellipsis } from '@nutui/nutui-taro';
 
 const app = createApp();
-app.use();
+app.use(Ellipsis);
 
 ```
 
@@ -90,8 +90,8 @@ app.use();
 | content         | Content               | String | -                |
 | direction         | Direction                | 'start' | 'end' | 'middle' | 'end'               |
 | rows         | Rows               | Number | 1              |
-| expandText         | Expand text               | String | ''              |
-| collapseText         | Collapse text               | String | ''               |
+| expand-text         | Expand text               | String | ''              |
+| collapse-text         | Collapse text               | String | ''               |
 | symbol         | Symbol     | String | '...'       |
 
 ### Events

+ 3 - 3
src/packages/__VUE/ellipsis/doc.md

@@ -15,7 +15,7 @@ import { Ellipsis } from '@nutui/nutui';
 import { Ellipsis } from '@nutui/nutui-taro';
 
 const app = createApp();
-app.use();
+app.use(Ellipsis);
 
 ```
 
@@ -90,8 +90,8 @@ app.use();
 | content         | 文本内容               | String | -                |
 | direction         | 省略位置               | 'start' | 'end' | 'middle' | 'end'               |
 | rows         | 展示几行               | Number | 1              |
-| expandText         | 展开操作的文案               | String | ''              |
-| collapseText         | 收起操作的文案               | String | ''               |
+| expand-text         | 展开操作的文案               | String | ''              |
+| collapse-text         | 收起操作的文案               | String | ''               |
 | symbol         | 省略的符号     | String | '...'       |
 
 ### Events

+ 9 - 9
src/packages/__VUE/noticebar/doc.en-US.md

@@ -213,15 +213,15 @@ When text is long, you can enable multi-line display by setting the wrapable pro
 
 :::
 
-### Prop
+### Props
 
 | Attribute  | Description                                        | Type          | Default |
 | ---------- | ---------------------------------------------------| ------------- | ------- |
 | direction  | Rolling direction                                  | String        | across  |
 | text       | Notice text content                                | String        |  -      |
-| closeMode  | Whether to enable the off mode                     | Boolean       | false   |
-| leftIcon   | Left Icon                                          | String        | -       |
-| rightIcon  | Right Icon                                         | String        | -       |
+| close-mode  | Whether to enable the off mode                     | Boolean       | false   |
+| left-icon   | Left Icon                                          | String        | -       |
+| right-icon  | Right Icon                                         | String        | -       |
 | color      | Text Color                                         | String        | -       |
 | background | Background                                         | String        | -       |
 | delay      | Delay time                                         | String/Number | 1       |
@@ -229,16 +229,16 @@ When text is long, you can enable multi-line display by setting the wrapable pro
 | speed      | Scrolling speed (px/s)                             | Number         | 50      |
 | wrapable`v3.1.18` | Whether to enable text wrap                        | Boolean       | false    |
 
-### Prop(direction=vertical)
+### Props(direction=vertical)
 
 | Attribute    | Description                             | Type     | Default          |
 |--------------|-----------------------------------------|----------|------------------|
 | list         | List                                    | Array    | []               |
 | speed        | Scrolling speed                         | Number   | 50               |
-| standTime    | Show time(millisecond)                  | Number   | 1000             |
-| complexAm    | Complex animation                       | Boolean  | false            |
+| stand-time    | Show time(millisecond)                  | Number   | 1000             |
+| complex-am    | Complex animation                       | Boolean  | false            |
 | height       | height                                  | Number   | 40               |
-| closeMode    | Whether to enable the off mode          | Boolean  | false            |
+| close-mode    | Whether to enable the off mode          | Boolean  | false            |
 
 ### Slots
 
@@ -248,7 +248,7 @@ When text is long, you can enable multi-line display by setting the wrapable pro
 | right-icon        | Custom right icon                |
 | left-icon         | Custom left icon                 |
 
-### Event
+### Events
 
 | Attribute  | Description                             | Arguments     |
 | ---------- | --------------------------------------- | ------------ |

+ 9 - 9
src/packages/__VUE/noticebar/doc.md

@@ -215,15 +215,15 @@ app.use(NoticeBar);
 :::
 
 
-### Prop
+### Props
 
 | 字段       | 说明                                                       | 类型          | 默认值 |
 | ---------- | ---------------------------------------------------------- | ------------- | ------ |
 | direction       | 滚动的方向,可选 across、vertical                         | String        | across     |
 | text       | 提示的信息                                                 | String        | 空     |
-| closeMode  | 是否启用关闭模式                                           | Boolean       | false  |
-| leftIcon   | close为没有左边icon,其他为自定义的图片链接,没有为默认图片 | String        | 空     |
-| rightIcon   | closeMode 模式下,默认为 ‘close’,其他模式下,没有为默认图片 | String        | 空     |
+| close-mode  | 是否启用关闭模式                                           | Boolean       | false  |
+| left-icon   | close为没有左边icon,其他为自定义的图片链接,没有为默认图片 | String        | 空     |
+| right-icon   | closeMode 模式下,默认为 ‘close’,其他模式下,没有为默认图片 | String        | 空     |
 | color      | 导航栏的文字颜色                                           | String        | 空     |
 | background | 导航栏的背景颜色                                           | String        | 空     |
 | delay      | 延时多少秒                                                 | String/Number | 1      |
@@ -231,16 +231,16 @@ app.use(NoticeBar);
 | speed      | 滚动速率 (px/s)                                            | Number        | 50     |
 | wrapable `v3.1.18`  | 是否开启文本换行                                           | Boolean       | false    |
 
-### Prop(direction=vertical)
+### Props(direction=vertical)
 
 | 参数         | 说明                             | 类型   | 默认值           |
 |--------------|----------------------------------|--------|------------------|
 | list         | 纵向滚动数据列表               | Array | []               |
 | speed        | 滚动的速度                         | Number | 50               |
-| standTime         | 停留时间(毫秒) | Number | 1000                |
-| complexAm | 稍复杂的动画,耗能会高     | Boolean | false |
+| stand-time         | 停留时间(毫秒) | Number | 1000                |
+| complex-am | 稍复杂的动画,耗能会高     | Boolean | false |
 | height          | 每一个滚动列的高度(px),注意:在使用 slot 插槽定义滚动单元时,按照实际高度修改此值                 | Number | 40              |
-| closeMode  | 是否启用右侧关闭图标,可以通过slot[name=rightIcon]自定义图标                                   | Boolean       | false  |
+| close-mode  | 是否启用右侧关闭图标,可以通过slot[name=rightIcon]自定义图标                                   | Boolean       | false  |
 
 ### Slots
 
@@ -249,7 +249,7 @@ app.use(NoticeBar);
 | default         | 通知文本的内容               | 
 | right-icon        | 自定义右侧图标    | 
 | left-icon        | 自定义左侧图标    | 
-### Event
+### Events
 
 | 字段  | 说明             | 回调参数     |
 | ----- | ---------------- | ------------ |

+ 2 - 1
src/packages/__VUE/pagination/doc.en-US.md

@@ -13,7 +13,8 @@ import { Pagination,Icon } from '@nutui/nutui';
 import { Pagination,Icon } from '@nutui/nutui-taro';
 
 const app = createApp();
-app.use(Pagination).use(Icon);
+app.use(Pagination);
+app.use(Icon);
 ```    
     
 ### Basic Usage

+ 2 - 1
src/packages/__VUE/pagination/doc.md

@@ -13,7 +13,8 @@ import { Pagination,Icon } from '@nutui/nutui';
 import { Pagination,Icon } from '@nutui/nutui-taro';
 
 const app = createApp();
-app.use(Pagination).use(Icon);
+app.use(Pagination);
+app.use(Icon);
 ```    
     
 ### 基础用法