Browse Source

docs(dialog、toast、swipe): edit api type

richard1015 3 years ago
parent
commit
8c0183cc35

+ 59 - 59
src/packages/__VUE/dialog/doc.en-US.md

@@ -210,66 +210,66 @@ export default {
 :::
 ## API
 ### DialogOptions
-| Attribute             | Description                                                                    | Type                     | Default              |
-|-----------------------|--------------------------------------------------------------------------------|--------------------------|----------------------|
-| title                 | Title                                                                          | String                   | -                    |
-| id                    | Identifier, share one instance at the same time, default to multiple instances | string \| object         | new Date().getTime() |
-| content               | Content, support HTML                                                          | String                   | -                    |
-| teleport              | Specifies a target element where Dialog will be mounted                        | String                   | "body"               |
-| closeOnClickOverlay   | Whether to close when overlay is clicked                                       | Boolean                  | false                |
-| noFooter              | Hide bottom button bar                                                         | Boolean                  | false                |
-| noOkBtn               | Hide OK button                                                                 | Boolean                  | false                |
-| noCancelBtn           | Hide cancel button                                                             | Boolean                  | false                |
-| cancelText            | Cancel button text                                                             | String                   | "Cancel"             |
-| okText                | OK button text                                                                 | String                   | "Confirm"            |
-| cancelAutoClose       | Click Cancel to close the popup                                                | Boolean                  | true                 |
-| textAlign             | Text alignment direction, the optional value is the same as css text-align     | String                   | "center"             |
-| closeOnPopstate       | Whether to close when popstate                                                 | Boolean                  | false                |
-| customClass  | Custom dialog class                                                            | String                   |                      |
-| overlayClass | Custom mask classname                                                          | String                   | -                    |
-| overlayStyle | Custom mask styles                                                             | CSSProperties            | -                    |
-| popClass   | Custom popup classname                                                         | String                   | -                    |
-| popStyle   | Custom popup styles                                                            | CSSProperties            | -                    |
-| onUpdate              | Update                                                                         | Boolean                  | false                |
-| onOk                  | Emitted when the confirm button is clicked                                     | Function                 | -                    |
-| onCancel              | Emitted when the cancel button is clicked                                      | Function                 | -                    |
-| onOpened     | Emitted when Dialog is opened                                                  | Function                 | -                    |
-| onClosed              | Emitted when Dialog is closed                                                  | Function                 | -                    |
-| beforeClose  | Callback function before close support return `promise`                        | Function(action: string) | -                    |
+| Attribute           | Description                                                                    | Type                     | Default              |
+|---------------------|--------------------------------------------------------------------------------|--------------------------|----------------------|
+| title               | Title                                                                          | string                   | -                    |
+| id                  | Identifier, share one instance at the same time, default to multiple instances | string \| object         | new Date().getTime() |
+| content             | Content, support HTML                                                          | string                   | -                    |
+| teleport            | Specifies a target element where Dialog will be mounted                        | string                   | "body"               |
+| closeOnClickOverlay | Whether to close when overlay is clicked                                       | boolean                  | false                |
+| noFooter            | Hide bottom button bar                                                         | boolean                  | false                |
+| noOkBtn             | Hide OK button                                                                 | boolean                  | false                |
+| noCancelBtn         | Hide cancel button                                                             | boolean                  | false                |
+| cancelText          | Cancel button text                                                             | string                   | "Cancel"             |
+| okText              | OK button text                                                                 | string                   | "Confirm"            |
+| cancelAutoClose     | Click Cancel to close the popup                                                | boolean                  | true                 |
+| textAlign           | Text alignment direction, the optional value is the same as css text-align     | string                   | "center"             |
+| closeOnPopstate     | Whether to close when popstate                                                 | boolean                  | false                |
+| customClass         | Custom dialog class                                                            | string                   |                      |
+| overlayClass        | Custom mask classname                                                          | string                   | -                    |
+| overlayStyle        | Custom mask styles                                                             | CSSProperties            | -                    |
+| popClass            | Custom popup classname                                                         | string                   | -                    |
+| popStyle            | Custom popup styles                                                            | CSSProperties            | -                    |
+| onUpdate            | Update                                                                         | boolean                  | false                |
+| onOk                | Emitted when the confirm button is clicked                                     | Function                 | -                    |
+| onCancel            | Emitted when the cancel button is clicked                                      | Function                 | -                    |
+| onOpened            | Emitted when Dialog is opened                                                  | Function                 | -                    |
+| onClosed            | Emitted when Dialog is closed                                                  | Function                 | -                    |
+| beforeClose         | Callback function before close support return `promise`                        | Function(action: string) | -                    |
 
 
 ### Props
 
-| Attribute              | Description                                                                                               | Type                     | Default    |
-|------------------------|-----------------------------------------------------------------------------------------------------------|--------------------------|------------|
-| title                  | Title                                                                                                     | String                   | -          |
-| content                | Content, support HTML                                                                                     | String                   | -          |
-| teleport               | Specifies a target element where Dialog will be mounted                                                   | String                   | "body"     |
-| close-on-click-overlay | Whether to close when overlay is clicked                                                                  | Boolean                  | false      |
-| no-footer              | Hide bottom button bar                                                                                    | Boolean                  | false      |
-| no-ok-btn              | Hide OK button                                                                                            | Boolean                  | false      |
-| no-cancel-btn          | Hide cancel button                                                                                        | Boolean                  | false      |
-| cancel-text            | Cancel button text                                                                                        | String                   | "Cancel"   |
-| ok-text                | OK button text                                                                                            | String                   | "Confirm"  |
-| cancel-auto-close      | Click Cancel to close the popup                                                                           | Boolean                  | true       |
-| text-align             | Text alignment direction, the optional value is the same as css text-align                                | String                   | "center"   |
-| close-on-popstate      | Whether to close when popstate                                                                            | Boolean                  | false      |
-| lock-scroll            | Whether to lock background scroll                                                                         | Boolean                  | false      |
-| footer-direction       | The bottom button uses the horizontal and vertical directions. Optional values ​​are horizontal and vertical. | string                   | horizontal |
-| overlay-class | Custom mask classname                                                                                     | String                   | -          |
-| overlay-style | Custom mask styles                                                                                        | CSSProperties            | -          |
-| pop-class   | Custom popup classname                                                                                    | String                   | -          |
-| pop-style   | Custom popup styles                                                                                       | CSSProperties            | -          |
-| custom-class  | Custom dialog class                                                                                       | String                   | -          |
-| before-close  | Callback function before close support return `promise`                                                   | Function(action: string) | -          |
+| Attribute              | Description                                                                | Type                     | Default    |
+|------------------------|----------------------------------------------------------------------------|--------------------------|------------|
+| title                  | Title                                                                      | string                   | -          |
+| content                | Content, support HTML                                                      | string                   | -          |
+| teleport               | Specifies a target element where Dialog will be mounted                    | string                   | "body"     |
+| close-on-click-overlay | Whether to close when overlay is clicked                                   | boolean                  | false      |
+| no-footer              | Hide bottom button bar                                                     | boolean                  | false      |
+| no-ok-btn              | Hide OK button                                                             | boolean                  | false      |
+| no-cancel-btn          | Hide cancel button                                                         | boolean                  | false      |
+| cancel-text            | Cancel button text                                                         | string                   | "Cancel"   |
+| ok-text                | OK button text                                                             | string                   | "Confirm"  |
+| cancel-auto-close      | Click Cancel to close the popup                                            | boolean                  | true       |
+| text-align             | Text alignment direction, the optional value is the same as css text-align | string                   | "center"   |
+| close-on-popstate      | Whether to close when popstate                                             | boolean                  | false      |
+| lock-scroll            | Whether to lock background scroll                                          | boolean                  | false      |
+| footer-direction       | Use `horizontal` and `vertical` optional values                            | string                   | horizontal |
+| overlay-class          | Custom mask classname                                                      | string                   | -          |
+| overlay-style          | Custom mask styles                                                         | CSSProperties            | -          |
+| pop-class              | Custom popup classname                                                     | string                   | -          |
+| pop-style              | Custom popup styles                                                        | CSSProperties            | -          |
+| custom-class           | Custom dialog class                                                        | string                   | -          |
+| before-close           | Callback function before close support return `promise`                    | Function(action: string) | -          |
 
 ### Events
 
-| Event           | Description                                | Type     | Default |
-|-----------------|--------------------------------------------|----------|---------|
-| ok              | Emitted when the confirm button is clicked | Function | -       |
-| cancel          | Emitted when the cancel button is clicked  | Function | -       |
-| closed          | Emitted when Dialog is closed              | Function | -       |
+| Event  | Description                                | Type     | Default |
+|--------|--------------------------------------------|----------|---------|
+| ok     | Emitted when the confirm button is clicked | Function | -       |
+| cancel | Emitted when the cancel button is clicked  | Function | -       |
+| closed | Emitted when Dialog is closed              | Function | -       |
 | opened | Emitted when Dialog is Opened              | Function | -       |
 
 
@@ -287,9 +287,9 @@ export default {
 
 The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider).
 
-| Name | Default Value | Description |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-dialog-width| _296px_  | -  |
-| --nut-dialog-header-font-weight| _normal_  | -  |
-| --nut-dialog-header-color| _rgba(38, 38, 38, 1)_  | -  |
-| --nut-dialog-footer-justify-content| _space-around_  | -  |
+| Name                                | Default Value         |
+|-------------------------------------|-----------------------|
+| --nut-dialog-width                  | _296px_               |
+| --nut-dialog-header-font-weight     | _normal_              |
+| --nut-dialog-header-color           | _rgba(38, 38, 38, 1)_ |
+| --nut-dialog-footer-justify-content | _space-around_        |

+ 53 - 53
src/packages/__VUE/dialog/doc.md

@@ -19,7 +19,7 @@ app.use(Dialog);
 ```
 
 
-### 函数调用(小程序模式暂不支持)
+### 函数调用
 
 :::demo
 ```html
@@ -211,58 +211,58 @@ export default {
 
 ## API
 ### DialogOptions
-| 字段                  | 说明                                                          | 类型                     | 默认值               |
-|-----------------------|---------------------------------------------------------------|--------------------------|----------------------|
-| title                 | 标题                                                          | String                   | -                    |
-| id                    | 标识符,相同时共用一个实例,默认为多个实例                    | String/Number            | new Date().getTime() |
-| content               | 内容,支持HTML和组件                                          | String/VNode             | -                    |
-| teleport              | 指定挂载节点                                                  | String                   | "body"               |
-| closeOnClickOverlay   | 点击蒙层是否关闭对话框                                        | Boolean                  | false                |
-| noFooter              | 是否隐藏底部按钮栏                                            | Boolean                  | false                |
-| noOkBtn               | 是否隐藏确定按钮                                              | Boolean                  | false                |
-| noCancelBtn           | 是否隐藏取消按钮                                              | Boolean                  | false                |
-| cancelText            | 取消按钮文案                                                  | String                   | ”取消“               |
-| okText                | 确定按钮文案                                                  | String                   | ”确定“               |
-| cancelAutoClose       | 取消按钮是否默认关闭弹窗                                      | Boolean                  | true                 |
-| textAlign             | 文字对齐方向,可选值同css的text-align                         | String                   | "center"             |
-| closeOnPopstate       | 是否在页面回退时自动关闭                                      | Boolean                  | false                |
-| customClass  | 自定义class                                                   | String                   |                      |
-| overlayClass | 自定义遮罩类名                                                | String                   | -                    |
-| overlayStyle | 自定义遮罩样式                                                | CSSProperties            | -                    |
-| popClass   | 自定义popup弹框类名                                           | String                   | -                    |
-| popStyle   | 自定义popup弹框样式                                           | CSSProperties            | -                    |
-| onUpdate              | 更新                                                          | Boolean                  | false                |
-| onOk                  | 确定按钮回调                                                  | Function                 | -                    |
-| onCancel              | 取消按钮回调                                                  | Function                 | -                    |
-| onOpened     | 打开弹框后回调                                                | Function                 | -                    |
-| onClosed              | 关闭弹框后回调                                                | Function                 | -                    |
-| beforeClose  | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 `Promise` | Function(action: string) | -                    |
+| 字段                | 说明                                                          | 类型                     | 默认值               |
+|---------------------|---------------------------------------------------------------|--------------------------|----------------------|
+| title               | 标题                                                          | string                   | -                    |
+| id                  | 标识符,相同时共用一个实例,默认为多个实例                    | string \| number         | new Date().getTime() |
+| content             | 内容,支持HTML和组件                                          | string \| VNode          | -                    |
+| teleport            | 指定挂载节点                                                  | string                   | "body"               |
+| closeOnClickOverlay | 点击蒙层是否关闭对话框                                        | boolean                  | false                |
+| noFooter            | 是否隐藏底部按钮栏                                            | boolean                  | false                |
+| noOkBtn             | 是否隐藏确定按钮                                              | boolean                  | false                |
+| noCancelBtn         | 是否隐藏取消按钮                                              | boolean                  | false                |
+| cancelText          | 取消按钮文案                                                  | string                   | ”取消“               |
+| okText              | 确定按钮文案                                                  | string                   | ”确定“               |
+| cancelAutoClose     | 取消按钮是否默认关闭弹窗                                      | boolean                  | true                 |
+| textAlign           | 文字对齐方向,可选值同css的text-align                         | string                   | "center"             |
+| closeOnPopstate     | 是否在页面回退时自动关闭                                      | boolean                  | false                |
+| customClass         | 自定义class                                                   | string                   |                      |
+| overlayClass        | 自定义遮罩类名                                                | string                   | -                    |
+| overlayStyle        | 自定义遮罩样式                                                | CSSProperties            | -                    |
+| popClass            | 自定义popup弹框类名                                           | string                   | -                    |
+| popStyle            | 自定义popup弹框样式                                           | CSSProperties            | -                    |
+| onUpdate            | 更新                                                          | boolean                  | false                |
+| onOk                | 确定按钮回调                                                  | Function                 | -                    |
+| onCancel            | 取消按钮回调                                                  | Function                 | -                    |
+| onOpened            | 打开弹框后回调                                                | Function                 | -                    |
+| onClosed            | 关闭弹框后回调                                                | Function                 | -                    |
+| beforeClose         | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 `Promise` | Function(action: string) | -                    |
 
 
 ### Props
 
 | 字段                   | 说明                                                          | 类型                     | 默认值     |
 |------------------------|---------------------------------------------------------------|--------------------------|------------|
-| title                  | 标题                                                          | String                   | -          |
-| content                | 内容,支持HTML和组件                                          | String/VNode             | -          |
-| teleport               | 指定挂载节点                                                  | String                   | "body"     |
-| close-on-click-overlay | 点击蒙层是否关闭对话框                                        | Boolean                  | false      |
-| no-footer              | 是否隐藏底部按钮栏                                            | Boolean                  | false      |
-| no-ok-btn              | 是否隐藏确定按钮                                              | Boolean                  | false      |
-| no-cancel-btn          | 是否隐藏取消按钮                                              | Boolean                  | false      |
-| cancel-text            | 取消按钮文案                                                  | String                   | ”取消“     |
-| ok-text                | 确定按钮文案                                                  | String                   | ”确 定“    |
-| cancel-auto-close      | 取消按钮是否默认关闭弹窗                                      | Boolean                  | true       |
-| text-align             | 文字对齐方向,可选值同css的text-align                         | String                   | "center"   |
-| close-on-popstate      | 是否在页面回退时自动关闭                                      | Boolean                  | false      |
-| lock-scroll            | 背景是否锁定                                                  | Boolean                  | false      |
-| footer-direction       | 使用横纵方向 可选值 horizontal、vertical                      | string                   | horizontal |
-| overlay-class | 自定义遮罩类名                                                | String                   | -          |
-| overlay-style | 自定义遮罩样式                                                | CSSProperties            | -          |
-| pop-class    | 自定义popup弹框类名                                           | String                   | -          |
-| pop-style   | 自定义popup弹框样式                                           | CSSProperties            | -          |
-| custom-class  | 自定义class                                                   | String                   | -          |
-| before-close  | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 `Promise` | Function(action: string) | -          |
+| title                  | 标题                                                          | string                   | -          |
+| content                | 内容,支持 HTML 和组件                                        | string \| VNode          |            |
+| teleport               | 指定挂载节点                                                  | string                   | "body"     |
+| close-on-click-overlay | 点击蒙层是否关闭对话框                                        | boolean                  | false      |
+| no-footer              | 是否隐藏底部按钮栏                                            | boolean                  | false      |
+| no-ok-btn              | 是否隐藏确定按钮                                              | boolean                  | false      |
+| no-cancel-btn          | 是否隐藏取消按钮                                              | boolean                  | false      |
+| cancel-text            | 取消按钮文案                                                  | string                   | ”取消“     |
+| ok-text                | 确定按钮文案                                                  | string                   | ”确 定“    |
+| cancel-auto-close      | 取消按钮是否默认关闭弹窗                                      | boolean                  | true       |
+| text-align             | 文字对齐方向,可选值同 css 的 text-align                      | string                   | "center"   |
+| close-on-popstate      | 是否在页面回退时自动关闭                                      | boolean                  | false      |
+| lock-scroll            | 背景是否锁定                                                  | boolean                  | false      |
+| footer-direction       | 使用横纵方向 可选值 `horizontal`、`vertical`                  | string                   | horizontal |
+| overlay-class          | 自定义遮罩类名                                                | string                   | -          |
+| overlay-style          | 自定义遮罩样式                                                | CSSProperties            | -          |
+| pop-class              | 自定义popup弹框类名                                           | string                   | -          |
+| pop-style              | 自定义popup弹框样式                                           | CSSProperties            | -          |
+| custom-class           | 自定义class                                                   | string                   | -          |
+| before-close           | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 `Promise` | Function(action: string) | -          |
 
 ### Events
 
@@ -288,9 +288,9 @@ export default {
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-dialog-width| _296px_  | -  |
-| --nut-dialog-header-font-weight| _normal_  | -  |
-| --nut-dialog-header-color| _rgba(38, 38, 38, 1)_  | -  |
-| --nut-dialog-footer-justify-content| _space-around_  | -  |
+| 名称                                | 默认值                |
+|-------------------------------------|-----------------------|
+| --nut-dialog-width                  | _296px_               |
+| --nut-dialog-header-font-weight     | _normal_              |
+| --nut-dialog-header-color           | _rgba(38, 38, 38, 1)_ |
+| --nut-dialog-footer-justify-content | _space-around_        |

+ 26 - 26
src/packages/__VUE/dialog/doc.taro.md

@@ -117,26 +117,26 @@ export default {
 
 | 字段                   | 说明                                                          | 类型                     | 默认值     |
 |------------------------|---------------------------------------------------------------|--------------------------|------------|
-| title                  | 标题                                                          | String                   | -          |
-| content                | 内容,支持HTML和组件                                          | String/VNode             | -          |
-| teleport               | 指定挂载节点                                                  | String                   | "body"     |
-| close-on-click-overlay | 点击蒙层是否关闭对话框                                        | Boolean                  | false      |
-| no-footer              | 是否隐藏底部按钮栏                                            | Boolean                  | false      |
-| no-ok-btn              | 是否隐藏确定按钮                                              | Boolean                  | false      |
-| no-cancel-btn          | 是否隐藏取消按钮                                              | Boolean                  | false      |
-| cancel-text            | 取消按钮文案                                                  | String                   | ”取消“     |
-| ok-text                | 确定按钮文案                                                  | String                   | ”确 定“    |
-| cancel-auto-close      | 取消按钮是否默认关闭弹窗                                      | Boolean                  | true       |
-| text-align             | 文字对齐方向,可选值同css的text-align                         | String                   | "center"   |
-| close-on-popstate      | 是否在页面回退时自动关闭                                      | Boolean                  | false      |
-| lock-scroll            | 背景是否锁定                                                  | Boolean                  | false      |
-| footer-direction       | 使用横纵方向 可选值 horizontal、vertical                      | string                   | horizontal |
-| overlay-class | 自定义遮罩类名                                                | String                   | -          |
-| overlay-style | 自定义遮罩样式                                                | CSSProperties            | -          |
-| pop-class   | 自定义popup弹框类名                                           | String                   | -          |
-| pop-style   | 自定义popup弹框样式                                           | CSSProperties            | -          |
-| custom-class  | 自定义class                                                   | String                   | -          |
-| before-close  | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 `Promise` | Function(action: string) | -          |
+| title                  | 标题                                                          | string                   | -          |
+| content                | 内容,支持HTML和组件                                          | string \| VNode          | -          |
+| teleport               | 指定挂载节点                                                  | string                   | "body"     |
+| close-on-click-overlay | 点击蒙层是否关闭对话框                                        | boolean                  | false      |
+| no-footer              | 是否隐藏底部按钮栏                                            | boolean                  | false      |
+| no-ok-btn              | 是否隐藏确定按钮                                              | boolean                  | false      |
+| no-cancel-btn          | 是否隐藏取消按钮                                              | boolean                  | false      |
+| cancel-text            | 取消按钮文案                                                  | string                   | ”取消“     |
+| ok-text                | 确定按钮文案                                                  | string                   | ”确 定“    |
+| cancel-auto-close      | 取消按钮是否默认关闭弹窗                                      | boolean                  | true       |
+| text-align             | 文字对齐方向,可选值同 css 的 text-align                      | string                   | "center"   |
+| close-on-popstate      | 是否在页面回退时自动关闭                                      | boolean                  | false      |
+| lock-scroll            | 背景是否锁定                                                  | boolean                  | false      |
+| footer-direction       | 使用横纵方向 可选值 `horizontal`、`vertical`                  | string                   | horizontal |
+| overlay-class          | 自定义遮罩类名                                                | string                   | -          |
+| overlay-style          | 自定义遮罩样式                                                | CSSProperties            | -          |
+| pop-class              | 自定义popup弹框类名                                           | string                   | -          |
+| pop-style              | 自定义popup弹框样式                                           | CSSProperties            | -          |
+| custom-class           | 自定义class                                                   | string                   | -          |
+| before-close           | 关闭前的回调函数,返回 `false` 可阻止关闭,支持返回 `Promise` | Function(action: string) | -          |
 
 
 ### Events
@@ -163,9 +163,9 @@ export default {
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-dialog-width| _296px_  | -  |
-| --nut-dialog-header-font-weight| _normal_  | -  |
-| --nut-dialog-header-color| _rgba(38, 38, 38, 1)_  | -  |
-| --nut-dialog-footer-justify-content| _space-around_  | -  |
+| 名称                                | 默认值                |
+|-------------------------------------|-----------------------|
+| --nut-dialog-width                  | _296px_               |
+| --nut-dialog-header-font-weight     | _normal_              |
+| --nut-dialog-header-color           | _rgba(38, 38, 38, 1)_ |
+| --nut-dialog-footer-justify-content | _space-around_        |

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

@@ -228,7 +228,7 @@ When text is long, you can enable multi-line display by setting the wrapable pro
 | right-icon  | Right Icon                                         | String        | -       |
 | color      | Text Color                                         | String        | -       |
 | background | Background                                         | String        | -       |
-| delay      | Delay time                                         | String/Number | 1       |
+| delay      | Delay time                                         | string \| number | 1       |
 | scrollable | Whether to scroll content                          | Boolean       | true    |
 | speed      | Scrolling speed (px/s)                             | Number         | 50      |
 | wrapable | Whether to enable text wrap                        | Boolean       | false    |

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

@@ -230,7 +230,7 @@ app.use(Noticebar);
 | right-icon   | closeMode 模式下,默认为 ‘close’,其他模式下,没有为默认图片 | String        | 空     |
 | color      | 导航栏的文字颜色                                           | String        | 空     |
 | background | 导航栏的背景颜色                                           | String        | 空     |
-| delay      | 延时多少秒                                                 | String/Number | 1      |
+| delay      | 延时多少秒                                                 | string \| number | 1      |
 | scrollable | 是否可以滚动                                               | Boolean       | true   |
 | speed      | 滚动速率 (px/s)                                            | Number        | 50     |
 | wrapable  | 是否开启文本换行                                           | Boolean       | false    |

+ 1 - 1
src/packages/__VUE/noticebar/doc.taro.md

@@ -225,7 +225,7 @@ app.use(Noticebar);
 | right-icon   | closeMode 模式下,默认为 ‘close’,其他模式下,没有为默认图片 | String        | 空     |
 | color      | 导航栏的文字颜色                                           | String        | 空     |
 | background | 导航栏的背景颜色                                           | String        | 空     |
-| delay      | 延时多少秒                                                 | String/Number | 1      |
+| delay      | 延时多少秒                                                 | string \| number | 1      |
 | scrollable | 是否可以滚动                                               | Boolean       | true   |
 | speed      | 滚动速率 (px/s)                                            | Number        | 50     |
 | wrapable  | 是否开启文本换行                                           | Boolean       | false    |

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

@@ -172,7 +172,7 @@ export default {
 | duration   | Display duration (ms),value is 0 ,notify not disappear | Number        | 3000     |
 | color      | Font Color                                               | String        | -        |
 | background | Background color                                         | String        | -        |
-| class-name | Custom class name                                        | String/Number | 1        |
+| class-name | Custom class name                                        | string \| number | 1        |
 | position | custom position, optional values are `top` `bottom` `left` `right` `center` | String | `top` |
 
 > Component call is supported after version 'v3.1.20'.

+ 1 - 1
src/packages/__VUE/notify/doc.taro.md

@@ -110,7 +110,7 @@ export default {
 | duration   | 展示时长(ms),值为 0 时,notify 不会消失              | Number        | 3000     |
 | color      | 字体颜色                                              | String        | 空       |
 | background | 背景颜色                                              | String        | 空       |
-| class-name | 自定义类名                                            | String/Number | 1        |
+| class-name | 自定义类名                                            | string \| number | 1        |
 | position | 自定义位置,可选值为 `top` `bottom` `left` `right` `center`              | String | `top`        |
 
 ### Events

+ 14 - 14
src/packages/__VUE/swipe/doc.en-US.md

@@ -150,18 +150,18 @@ export default {
 ## API
 ### Props
 
-| Attribute                   | Description               | Type    | Default |
-|-----------------------------|---------------------------|---------|---------|
-| name                        | identifies                | String  | -       |
-| disabled                    | Whether to disabled swipe | String  | false   |
-| touch-move-prevent-default  | Whether to stop touchmove event preventdefault       | boolean | false   |
-| touch-move-stop-propagation | Whether to stop touchmove event propagation      | boolean | false   |
+| Attribute                   | Description                                    | Type    | Default |
+|-----------------------------|------------------------------------------------|---------|---------|
+| name                        | identifies                                     | string  | -       |
+| disabled                    | Whether to disabled swipe                      | string  | false   |
+| touch-move-prevent-default  | Whether to stop touchmove event preventdefault | boolean | false   |
+| touch-move-stop-propagation | Whether to stop touchmove event propagation    | boolean | false   |
 ### Events
 
-| Event | Description                  | Arguments              |
-|-------|------------------------------|------------------------|
-| open  | Emitted when Swipe is opened | {type:'left or right'} |
-| close | Emitted when Swipe is closed | {type:'left or right'} |
+| Event | Description                  | Arguments                  |
+|-------|------------------------------|----------------------------|
+| open  | Emitted when Swipe is opened | { type:'left' \| 'right' } |
+| close | Emitted when Swipe is closed | { type:'left' \| 'right' } |
     
 
 ### Slots
@@ -175,7 +175,7 @@ export default {
 
 Use [ref](https://vuejs.org/guide/essentials/template-refs.html) to get Swipe instance and call instance methods.
 
-| Name  | Description | Arguments     |
-|-------|-------------|---------------|
-| open  | open swipe  | left or right |
-| close | close swipe |               |
+| Name  | Description | Arguments         |
+|-------|-------------|-------------------|
+| open  | open swipe  | 'left' \| 'right' |
+| close | close swipe |                   |

+ 12 - 12
src/packages/__VUE/swipe/doc.md

@@ -151,18 +151,18 @@ export default {
 ## API
 ### Props
 
-| 参数                     | 说明                 | 类型    | 默认值 |
-|--------------------------|----------------------|---------|--------|
-| name                     | 唯一标识             | String  | -      |
-| disabled                 | 是否禁用滑动         | String  | false  |
+| 参数                        | 说明                 | 类型    | 默认值 |
+|-----------------------------|----------------------|---------|--------|
+| name                        | 唯一标识             | string  | -      |
+| disabled                    | 是否禁用滑动         | string  | false  |
 | touch-move-prevent-default  | 是否阻止滑动事件行为 | boolean | false  |
 | touch-move-stop-propagation | 是否阻止滑动事件冒泡 | boolean | false  |
 ### Events
 
-| 事件名 | 说明       | 回调参数               |
-|--------|------------|------------------------|
-| open   | 打开时触发 | {type:'left or right'} |
-| close  | 关闭时触发 | {type:'left or right'} |
+| 事件名 | 说明       | 回调参数                   |
+|--------|------------|----------------------------|
+| open   | 打开时触发 | { type:'left' \| 'right' } |
+| close  | 关闭时触发 | { type:'left' \| 'right' } |
     
 
 ### Slots
@@ -175,7 +175,7 @@ export default {
 ### 方法
 通过 [ref](https://vuejs.org/guide/essentials/template-refs.html) 可以获取到 Swipe 实例并调用实例方法。
 
-| 方法名 | 说明             | 参数          |
-|--------|------------------|---------------|
-| open   | 打开单元格侧边栏 | left or right |
-| close  | 收起单元格侧边栏 |               |
+| 方法名 | 说明             | 参数              |
+|--------|------------------|-------------------|
+| open   | 打开单元格侧边栏 | 'left' \| 'right' |
+| close  | 收起单元格侧边栏 |                   |

+ 12 - 12
src/packages/__VUE/swipe/doc.taro.md

@@ -151,18 +151,18 @@ export default {
 ## API
 ### Props
 
-| 参数                     | 说明                 | 类型    | 默认值 |
-|--------------------------|----------------------|---------|--------|
-| name                     | 唯一标识             | String  | -      |
-| disabled                 | 是否禁用滑动         | String  | false  |
+| 参数                        | 说明                 | 类型    | 默认值 |
+|-----------------------------|----------------------|---------|--------|
+| name                        | 唯一标识             | string  | -      |
+| disabled                    | 是否禁用滑动         | string  | false  |
 | touch-move-prevent-default  | 是否阻止滑动事件行为 | boolean | false  |
 | touch-move-stop-propagation | 是否阻止滑动事件冒泡 | boolean | false  |
 ### Events
 
-| 事件名 | 说明       | 回调参数               |
-|--------|------------|------------------------|
-| open   | 打开时触发 | {type:'left or right'} |
-| close  | 关闭时触发 | {type:'left or right'} |
+| 事件名 | 说明       | 回调参数                   |
+|--------|------------|----------------------------|
+| open   | 打开时触发 | { type:'left' \| 'right' } |
+| close  | 关闭时触发 | { type:'left' \| 'right' } |
     
 
 ### Slots
@@ -175,7 +175,7 @@ export default {
 ### 方法
 通过 [ref](https://vuejs.org/guide/essentials/template-refs.html) 可以获取到 Swipe 实例并调用实例方法。
 
-| 方法名 | 说明             | 参数          |
-|--------|------------------|---------------|
-| open   | 打开单元格侧边栏 | left or right |
-| close  | 收起单元格侧边栏 |               |
+| 方法名 | 说明             | 参数              |
+|--------|------------------|-------------------|
+| open   | 打开单元格侧边栏 | 'left' \| 'right' |
+| close  | 收起单元格侧边栏 |                   |

+ 29 - 29
src/packages/__VUE/toast/doc.en-US.md

@@ -267,8 +267,8 @@ toast.hide();
 
 ## API
 ### Methods
-| Methods       | Description        | Attribute         | Return value                                  |
-|---------------|--------------------|-------------------|-----------------------------------------------|
+| Methods           | Description        | Attribute         | Return value                                  |
+|-------------------|--------------------|-------------------|-----------------------------------------------|
 | showToast.text    | Show text toast    | message| options | toast instance(message support incoming HTML) |
 | showToast.success | Show success toast | message| options | toast instance                                |
 | showToast.fail    | Show fail toast    | message| options | toast instance                                |
@@ -278,24 +278,24 @@ toast.hide();
 
 ### ToastOptions
 
-| 字段                   | 说明                                                                                               | 类型          | 默认值             |
-|------------------------|----------------------------------------------------------------------------------------------------|---------------|--------------------|
-| id                     | Identifier, share one instance at the same time, default to multiple instances                     | String/Number | -                  |
-| duration               | Toast duration(ms), won't disappear if value is 0                                                  | Number        | 2000               |
-| title                  | title                                                                                              | String        | -                  |
-| center                 | Whether to display in the middle of the page (display at the bottom when false)                    | Boolean       | true               |
-| bottom                 | The distance from the bottom of the page (px or %), which takes effect when option.center is false | String        | 30px               |
-| text-align-center      | Whether the multi-line copy is centered                                                            | Boolean       | true               |
-| bgColor                | background color (transparency)                                                                    | String        | rgba(0, 0, 0, 0.8) |
-| custom-class           | Custom Class                                                                                       | String        | -                  |
-| icon                   | Custom Icon                                                                                        | Component     | -                  |
-| size                   | Text Size **small**/**base**/**large**                                                             | String        | base               |
-| cover                  | Whether to show the mask layer                                                                     | Boolean       | false              |
-| cover-color            | Cover Color                                                                                        | String        | rgba(0,0,0,0)      |
-| loading-rotate         | Whether the loading icon is rotated, only valid for the loading type                               | Boolean       | true               |
-| close                  | Callback function after close                                                                      | function      | null               |
-| close-on-click-overlay | Whether to close when overlay is clicked                                                           | Boolean       | false              |
-| custom-class           | Custom Class                                                                                       | String        | -                  |
+| 字段                   | 说明                                                                                               | 类型             | 默认值             |
+|------------------------|----------------------------------------------------------------------------------------------------|------------------|--------------------|
+| id                     | Identifier, share one instance at the same time, default to multiple instances                     | string \| number | -                  |
+| duration               | Toast duration(ms), won't disappear if value is 0                                                  | number           | 2000               |
+| title                  | title                                                                                              | string           | -                  |
+| center                 | Whether to display in the middle of the page (display at the bottom when false)                    | boolean          | true               |
+| bottom                 | The distance from the bottom of the page (px or %), which takes effect when option.center is false | string           | 30px               |
+| text-align-center      | Whether the multi-line copy is centered                                                            | boolean          | true               |
+| bgColor                | background color (transparency)                                                                    | string           | rgba(0, 0, 0, 0.8) |
+| custom-class           | Custom Class                                                                                       | string           | -                  |
+| icon                   | Custom Icon                                                                                        | Component        | -                  |
+| size                   | Text Size **small**/**base**/**large**                                                             | string           | base               |
+| cover                  | Whether to show the mask layer                                                                     | boolean          | false              |
+| cover-color            | Cover Color                                                                                        | string           | rgba(0,0,0,0)      |
+| loading-rotate         | Whether the loading icon is rotated, only valid for the loading type                               | boolean          | true               |
+| close                  | Callback function after close                                                                      | function         | null               |
+| close-on-click-overlay | Whether to close when overlay is clicked                                                           | boolean          | false              |
+| custom-class           | Custom Class                                                                                       | string           | -                  |
 
 ## Theming
 
@@ -303,13 +303,13 @@ toast.hide();
 
 The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider).
 
-| Name | Default Value | Description |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-toast-title-font-size| _16px_  | -  |
-| --nut-toast-text-font-size| _14px_  | -  |
-| --nut-toast-font-color| _var(--nut-white)_  | -  |
-| --nut-toast-inner-padding| _24px 30px_  | -  |
-| --nut-toast-inner-bg-color| _rgba(0, 0, 0, 0.8)_  | -  |
-| --nut-toast-inner-border-radius| _12px_  | -  |
-| --nut-toast-cover-bg-color| _rgba(0, 0, 0, 0)_  | -  |
+| Name                            | Default Value        |
+|---------------------------------|----------------------|
+| --nut-toast-title-font-size     | _16px_               |
+| --nut-toast-text-font-size      | _14px_               |
+| --nut-toast-font-color          | _var(--nut-white)_   |
+| --nut-toast-inner-padding       | _24px 30px_          |
+| --nut-toast-inner-bg-color      | _rgba(0, 0, 0, 0.8)_ |
+| --nut-toast-inner-border-radius | _12px_               |
+| --nut-toast-cover-bg-color      | _rgba(0, 0, 0, 0)_   |
 

+ 29 - 29
src/packages/__VUE/toast/doc.md

@@ -267,8 +267,8 @@ toast.hide();
 
 ## API
 ### 方法
-| 方法名        | 说明         | 参数                                 | 返回值                          |
-|---------------|--------------|--------------------------------------|---------------------------------|
+| 方法名            | 说明         | 参数                                 | 返回值                          |
+|-------------------|--------------|--------------------------------------|---------------------------------|
 | showToast.text    | 展示文字提示 | message| options                    | toast 实例(message支持传入HTML) |
 | showToast.success | 展示成功提示 | message| options                    | toast 实例                      |
 | showToast.fail    | 展示失败提示 | message| options                    | toast 实例                      |
@@ -278,24 +278,24 @@ toast.hide();
 
 ### ToastOptions 数据结构
 
-| 字段                   | 说明                                                           | 类型          | 默认值             |
-|------------------------|----------------------------------------------------------------|---------------|--------------------|
-| id                     | 标识符,相同时共用一个实例,默认为多个实例                     | String/Number | -                  |
-| duration               | 展示时长(毫秒)<br>值为 0 时,toast 不会自动消失              | Number        | 2000               |
-| title                  | 标题                                                           | String        | -                  |
-| center                 | 是否展示在页面中部(为false时展示在底部)                      | Boolean       | true               |
-| bottom                 | 距页面底部的距离(像素或者百分比),option.center为false时生效 | String        | 30px               |
-| text-align-center      | 多行文案是否居中                                               | Boolean       | true               |
-| bg-color               | 背景颜色(透明度)                                             | String        | rgba(0, 0, 0, 0.8) |
-| custom-class           | 自定义类名                                                     | String        | -                  |
-| icon                   | 自定义图标,**直接传入Component 或者 h函数**                   | Component     | -                  |
-| size                   | 文案尺寸,**small**/**base**/**large**三选一                   | String        | base               |
-| cover                  | 是否显示遮罩层                                                 | Boolean       | false              |
-| cover-color            | 遮罩层颜色,默认透明                                           | String        | rgba(0,0,0,0)      |
-| loading-rotate         | loading图标是否旋转,仅对loading类型生效                       | Boolean       | true               |
-| close                  | 关闭时触发的事件                                               | function      | null               |
-| close-on-click-overlay | 是否在点击遮罩层后关闭提示                                     | Boolean       | false              |
-| custom-class           | 提示框class                                                    | String        | -                  |
+| 字段                   | 说明                                                           | 类型             | 默认值             |
+|------------------------|----------------------------------------------------------------|------------------|--------------------|
+| id                     | 标识符,相同时共用一个实例,默认为多个实例                     | string \| number | -                  |
+| duration               | 展示时长(毫秒)<br>值为 0 时,toast 不会自动消失              | number           | 2000               |
+| title                  | 标题                                                           | string           | -                  |
+| center                 | 是否展示在页面中部(为false时展示在底部)                      | boolean          | true               |
+| bottom                 | 距页面底部的距离(像素或者百分比),option.center为false时生效 | string           | 30px               |
+| text-align-center      | 多行文案是否居中                                               | boolean          | true               |
+| bg-color               | 背景颜色(透明度)                                             | string           | rgba(0, 0, 0, 0.8) |
+| custom-class           | 自定义类名                                                     | string           | -                  |
+| icon                   | 自定义图标,**直接传入Component 或者 h函数**                   | Component        | -                  |
+| size                   | 文案尺寸,**small**/**base**/**large**三选一                   | string           | base               |
+| cover                  | 是否显示遮罩层                                                 | boolean          | false              |
+| cover-color            | 遮罩层颜色,默认透明                                           | string           | rgba(0,0,0,0)      |
+| loading-rotate         | loading图标是否旋转,仅对loading类型生效                       | boolean          | true               |
+| close                  | 关闭时触发的事件                                               | function         | null               |
+| close-on-click-overlay | 是否在点击遮罩层后关闭提示                                     | boolean          | false              |
+| custom-class           | 提示框class                                                    | string           | -                  |
 
 ## 主题定制
 
@@ -303,13 +303,13 @@ toast.hide();
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-toast-title-font-size| _16px_  | -  |
-| --nut-toast-text-font-size| _14px_  | -  |
-| --nut-toast-font-color| _var(--nut-white)_  | -  |
-| --nut-toast-inner-padding| _24px 30px_  | -  |
-| --nut-toast-inner-bg-color| _rgba(0, 0, 0, 0.8)_  | -  |
-| --nut-toast-inner-border-radius| _12px_  | -  |
-| --nut-toast-cover-bg-color| _rgba(0, 0, 0, 0)_  | -  |
+| 名称                            | 默认值               |
+|---------------------------------|----------------------|
+| --nut-toast-title-font-size     | _16px_               |
+| --nut-toast-text-font-size      | _14px_               |
+| --nut-toast-font-color          | _var(--nut-white)_   |
+| --nut-toast-inner-padding       | _24px 30px_          |
+| --nut-toast-inner-bg-color      | _rgba(0, 0, 0, 0.8)_ |
+| --nut-toast-inner-border-radius | _12px_               |
+| --nut-toast-cover-bg-color      | _rgba(0, 0, 0, 0)_   |
 

+ 29 - 29
src/packages/__VUE/toast/doc.taro.md

@@ -67,26 +67,26 @@ export default {
 ## API
 ### Props
 
-| 字段                   | 说明                                                                    | 类型         | 默认值                        |
-|------------------------|-------------------------------------------------------------------------|--------------|-------------------------------|
-| msg                    | 消息文本内容,支持传入HTML                                               | String/VNode | ""                            |
-| duration               | 展示时长(毫秒)<br>值为 0 时,toast 不会自动消失(loading类型默认为0) | Number       | 2000                          |
-| title                  | 标题                                                                    | String       | ''                            |
-| center                 | 是否展示在页面中部(为false时展示在底部)                               | Boolean      | true                          |
-| bottom                 | 距页面底部的距离(像素或者百分比),option.center为false时生效          | String       | "30px"                        |
-| text-align-center      | 多行文案是否居中                                                        | Boolean      | true                          |
-| bg-color               | 背景颜色(透明度)                                                      | String       | "rgba(0, 0, 0, 0.8)"          |
-| custom-class           | 自定义类名                                                              | String       | ""                            |
-| icon                   | 自定义图标,**直接传入Component 或者 h函数**                            | Component    | -                             |
-| size                   | 文案尺寸,**small**/**base**/**large**三选一                            | String       | "base"                        |
-| cover                  | 是否显示遮罩层,loading类型默认显示                                     | Boolean      | loading类型true/其他类型false |
-| cover-color            | 遮罩层颜色,默认透明                                                    | String       | "rgba(0,0,0,0)"               |
-| loading-rotate         | loading图标是否旋转,仅对loading类型生效                                | Boolean      | true                          |
-| on-close               | 关闭时触发的事件                                                        | function     | null                          |
-| close-on-click-overlay | 是否在点击遮罩层后关闭提示                                              | Boolean      | false                         |
-| toast-style            | 提示框style                                                             | object       | {}                            |
-| toast-class            | 提示框class                                                             | String       | ""                            |
-| type                   | 弹框类型 可选值(text、success、fail、warn、loading)                   | String       | ""                            |
+| 字段                   | 说明                                                                    | 类型            | 默认值                        |
+|------------------------|-------------------------------------------------------------------------|-----------------|-------------------------------|
+| msg                    | 消息文本内容,支持传入HTML                                               | string \| VNode | ""                            |
+| duration               | 展示时长(毫秒)<br>值为 0 时,toast 不会自动消失(loading类型默认为0) | number          | 2000                          |
+| title                  | 标题                                                                    | string          | ''                            |
+| center                 | 是否展示在页面中部(为false时展示在底部)                               | boolean         | true                          |
+| bottom                 | 距页面底部的距离(像素或者百分比),option.center为false时生效          | string          | "30px"                        |
+| text-align-center      | 多行文案是否居中                                                        | boolean         | true                          |
+| bg-color               | 背景颜色(透明度)                                                      | string          | "rgba(0, 0, 0, 0.8)"          |
+| custom-class           | 自定义类名                                                              | string          | ""                            |
+| icon                   | 自定义图标,**直接传入Component 或者 h函数**                            | Component       | -                             |
+| size                   | 文案尺寸,**small**/**base**/**large**三选一                            | string          | "base"                        |
+| cover                  | 是否显示遮罩层,loading类型默认显示                                     | boolean         | loading类型true/其他类型false |
+| cover-color            | 遮罩层颜色,默认透明                                                    | string          | "rgba(0,0,0,0)"               |
+| loading-rotate         | loading图标是否旋转,仅对loading类型生效                                | boolean         | true                          |
+| on-close               | 关闭时触发的事件                                                        | function        | null                          |
+| close-on-click-overlay | 是否在点击遮罩层后关闭提示                                              | boolean         | false                         |
+| toast-style            | 提示框style                                                             | object          | {}                            |
+| toast-class            | 提示框class                                                             | string          | ""                            |
+| type                   | 弹框类型 可选值(text、success、fail、warn、loading)                   | string          | ""                            |
 
 ## 主题定制
 
@@ -94,13 +94,13 @@ export default {
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-toast-title-font-size| _16px_  | -  |
-| --nut-toast-text-font-size| _14px_  | -  |
-| --nut-toast-font-color| _var(--nut-white)_  | -  |
-| --nut-toast-inner-padding| _24px 30px_  | -  |
-| --nut-toast-inner-bg-color| _rgba(0, 0, 0, 0.8)_  | -  |
-| --nut-toast-inner-border-radius| _12px_  | -  |
-| --nut-toast-cover-bg-color| _rgba(0, 0, 0, 0)_  | -  |
+| 名称                            | 默认值               |
+|---------------------------------|----------------------|
+| --nut-toast-title-font-size     | _16px_               |
+| --nut-toast-text-font-size      | _14px_               |
+| --nut-toast-font-color          | _var(--nut-white)_   |
+| --nut-toast-inner-padding       | _24px 30px_          |
+| --nut-toast-inner-bg-color      | _rgba(0, 0, 0, 0.8)_ |
+| --nut-toast-inner-border-radius | _12px_               |
+| --nut-toast-cover-bg-color      | _rgba(0, 0, 0, 0)_   |