ソースを参照

fix: skeleton,signature文档修改

Ymm0008 3 年 前
コミット
5ef53966be

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

@@ -115,21 +115,20 @@ export default {
 ## API
     
 ### Props
-    
-| Attribute | Description | Type   | Default 
-|----- | ----- | ----- | ----- 
-| custom-class | Custom class | String | -
-| line-width | Width of line | Number | 3
-| stroke-style | Drawing stroke color | String | '#000'
-| type | Picture format | String | 'png'
-| un-support-tpl | Display copy without canvas | String | 'sorry, the current browser doesn't support canvas, so we can't use this control! '
+ | parameter | description | type | default
+|----- | ----- | ----- | -----
+| custom-class | custom `class` | string | `-`
+| line-width | line width | number | `3`
+| stroke-style | drawing stroke color | string | `#000`
+| type | image format | string | `png`
+| un-support-tpl | Display copy when Canvas is not supported | string | `Sorry, the current browser does not support Canvas, so this control cannot be used! `
 
 ### Events
 
-| Event | Description   | Arguments   |
-|----- | ----- | ----- 
-|start | signature start callback function (refers to the beginning of a stroke) | none
-|signing| the callback function being signed (refers to a stroke in progress) | event
-|end| signature end callback function (refers to the end of a stroke) | none
-| confirm | Click the confirm button to trigger the event callback function | Canvas and data URI displayed by signature image
-| clear | Click the re sign button to trigger the event callback function | -
+| field | description | callback parameter
+|----- | ----- | -----
+| start | Signature start callback function (refers to the start of a certain stroke) | `-`
+| signing | The callback function that is signing (referring to a certain stroke in progress) | `event`
+| end | Signature end callback function (referring to the end of a certain stroke) | `-`
+| confirm | Click the confirm button to trigger the event callback function | `canvas and signature image display data URI`
+| clear | Click the re-sign button to trigger the event callback function | `-`

+ 10 - 10
src/packages/__VUE/signature/doc.md

@@ -97,18 +97,18 @@ export default {
     
 | 参数 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
-| custom-class | 自定义class | String | -
-| line-width | 线条的宽度 | Number | 3
-| stroke-style | 绘图笔触颜色 | String | '#000'
-| type | 图片格式 | String | 'png'
-| un-support-tpl | 不支持Canvas情况下的展示文案 | String | '对不起,当前浏览器不支持Canvas,无法使用本控件!'
+| custom-class | 自定义 `class` | string | `-`
+| line-width | 线条的宽度 | number | `3`
+| stroke-style | 绘图笔触颜色 | string | `#000`
+| type | 图片格式 | string | `png`
+| un-support-tpl | 不支持Canvas情况下的展示文案 | string | `对不起,当前浏览器不支持Canvas,无法使用本控件!`
 
 ### Events
 
 | 字段 | 说明 | 回调参数 
 |----- | ----- | ----- 
-| start | 签名开始回调函数(指某次笔画的开始) | 
-| signing | 正在签名的回调函数(指某次笔画进行中) | event
-| end | 签名结束回调函数(指某次笔画的结束)| 
-| confirm | 点击确认按钮触发事件回调函数 | canvas和签名图片展示的 data URI
-| clear | 点击重签按钮触发事件回调函数 | 
+| start | 签名开始回调函数(指某次笔画的开始) | `-`
+| signing | 正在签名的回调函数(指某次笔画进行中) | `event`
+| end | 签名结束回调函数(指某次笔画的结束)| `-`
+| confirm | 点击确认按钮触发事件回调函数 | `canvas和签名图片展示的 data URI`
+| clear | 点击重签按钮触发事件回调函数 | `-`

+ 10 - 10
src/packages/__VUE/signature/doc.taro.md

@@ -67,18 +67,18 @@ export default {
     
 | 参数 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
-| custom-class | 自定义class | String | -
-| line-width | 线条的宽度 | Number | 3
-| stroke-style | 绘图笔触颜色 | String | '#000'
-| type | 图片格式 | String | 'png'
-| un-support-tpl | 不支持Canvas情况下的展示文案 | String | '对不起,当前浏览器不支持Canvas,无法使用本控件!'
+| custom-class | 自定义 `class` | string | `-`
+| line-width | 线条的宽度 | number | `3`
+| stroke-style | 绘图笔触颜色 | string | `#000`
+| type | 图片格式 | string | `png`
+| un-support-tpl | 不支持Canvas情况下的展示文案 | string | `对不起,当前浏览器不支持Canvas,无法使用本控件!`
 
 ### Events
 
 | 字段 | 说明 | 回调参数 
 |----- | ----- | ----- 
-| start| 签名开始回调函数(指某次笔画的开始) | 
-| signing| 正在签名的回调函数(指某次笔画进行中) | event
-| end| 签名结束回调函数(指某次笔画的结束)| 
-| confirm | 点击确认按钮触发事件回调函数 | data URI
-| clear | 点击重签按钮触发事件回调函数 | 
+| start | 签名开始回调函数(指某次笔画的开始) | `-`
+| signing | 正在签名的回调函数(指某次笔画进行中) | `event`
+| end | 签名结束回调函数(指某次笔画的结束)| `-`
+| confirm | 点击确认按钮触发事件回调函数 | `canvas和签名图片展示的 data URI`
+| clear | 点击重签按钮触发事件回调函数 | `-`

+ 10 - 10
src/packages/__VUE/skeleton/doc.en-US.md

@@ -158,16 +158,16 @@ export default {
 
 | Attribute | Description | Type   | Default |
 |------------|-------------------------------------------------|---------|----------|
-| loading    | Whether to display skeleton screen                                    | Boolean | `true`    | 
-| width       | Width per row                                        | String  | `default` |
-| height      | Height of each row                                        | String  | `100px`   |
-| animated    | Whether to turn on skeleton screen animation            | Boolean  | `false`  |
-| avatar      | Show avatar                      | Boolean | `false`   |
-| avatar-shape      | Avatar shape: square / round                       | String | `round`   |
-| avatar-size       | Avatar size                                   | String | `50px`    |
-| round  |         Is the title / paragraph rounded                       | Boolean | `false`  |
-| row    | Set the number of paragraph lines                                           | String | `1`       |
-| title  |           Show paragraph titles                              | Boolean | `true`   |
+| loading    | Whether to display skeleton screen                                    | boolean | `true`    | 
+| width       | Width per row                                        | string  | `default` |
+| height      | Height of each row                                        | string  | `100px`   |
+| animated    | Whether to turn on skeleton screen animation            | boolean  | `false`  |
+| avatar      | Show avatar                      | boolean | `false`   |
+| avatar-shape      | Avatar shape: square / round                       | string | `round`   |
+| avatar-size       | Avatar size                                   | string | `50px`    |
+| round  |         Is the title / paragraph rounded                       | boolean | `false`  |
+| row    | Set the number of paragraph lines                                           | string | `1`       |
+| title  |           Show paragraph titles                              | boolean | `true`   |
 
 
 ### Slots

+ 15 - 15
src/packages/__VUE/skeleton/doc.md

@@ -160,16 +160,16 @@ export default {
 
 | 字段       | 说明                                             | 类型    | 默认值    |
 |------------|-------------------------------------------------|---------|----------|
-| loading    | 是否显示骨架屏                                    | Boolean | `true`    | 
-| width       | 每行宽度                                        | String  | `default` |
-| height      | 每行高度                                        | String  | `100px`   |
-| animated    | 是否开启骨架屏动画                                | Boolean  | `false`  |
-| avatar      | 是否显示头像                                     | Boolean | `false`   |
-| avatar-shape      | 头像形状:正方形/圆形                        | String | `round`   |
-| avatar-size       | 头像大小                                   | String | `50px`    |
-| round  | 标题/段落是否采用圆角风格                                | Boolean | `false`  |
-| row    | 设置段落行数                                           | String | `1`       |
-| title  | 是否显示段落标题                                        | Boolean | `true`   |
+| loading    | 是否显示骨架屏                                    | boolean | `true`    | 
+| width       | 每行宽度                                        | string  | `default` |
+| height      | 每行高度                                        | string  | `100px`   |
+| animated    | 是否开启骨架屏动画                                | boolean  | `false`  |
+| avatar      | 是否显示头像                                     | boolean | `false`   |
+| avatar-shape      | 头像形状:正方形/圆形                        | string | `round`   |
+| avatar-size       | 头像大小                                   | string | `50px`    |
+| round  | 标题/段落是否采用圆角风格                                | boolean | `false`  |
+| row    | 设置段落行数                                           | string | `1`       |
+| title  | 是否显示段落标题                                        | boolean | `true`   |
 
 
 ### Slots
@@ -184,8 +184,8 @@ export default {
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-skeleton-content-avatar-background-color| _#efefef_  | -  |
-| --nut-skeleton-content-line-background-color| _#efefef_  | -  |
-| --nut-skeleton-animation-background-color| _linear-gradient(90deg,hsla(0, 0%, 100%, 0),hsla(0, 0%, 100%, 0.5) 50%, hsla(0, 0%, 100%, 0) 80%)_  | -  |
+| 名称                                    | 默认值                     |
+| --------------------------------------- | -------------------------- |
+| --nut-skeleton-content-avatar-background-color| _#efefef_  |
+| --nut-skeleton-content-line-background-color| _#efefef_  |
+| --nut-skeleton-animation-background-color| _linear-gradient(90deg,hsla(0, 0%, 100%, 0),hsla(0, 0%, 100%, 0.5) 50%, hsla(0, 0%, 100%, 0) 80%)_  |

+ 10 - 10
src/packages/__VUE/skeleton/doc.taro.md

@@ -160,16 +160,16 @@ export default {
 
 | 字段       | 说明                                             | 类型    | 默认值    |
 |------------|-------------------------------------------------|---------|----------|
-| loading    | 是否显示骨架屏                                    | Boolean | `true`    | 
-| width       | 每行宽度                                        | String  | `default` |
-| height      | 每行高度                                        | String  | `100px`   |
-| animated    | 是否开启骨架屏动画                                | Boolean  | `false`  |
-| avatar      | 是否显示头像                                     | Boolean | `false`   |
-| avatar-shape      | 头像形状:正方形/圆形                        | String | `round`   |
-| avatar-size       | 头像大小                                   | String | `50px`    |
-| round  | 标题/段落是否采用圆角风格                                | Boolean | `false`  |
-| row    | 设置段落行数                                           | String | `1`       |
-| title  | 是否显示段落标题                                        | Boolean | `true`   |
+| loading    | 是否显示骨架屏                                    | boolean | `true`    | 
+| width       | 每行宽度                                        | string  | `default` |
+| height      | 每行高度                                        | string  | `100px`   |
+| animated    | 是否开启骨架屏动画                                | boolean  | `false`  |
+| avatar      | 是否显示头像                                     | boolean | `false`   |
+| avatar-shape      | 头像形状:正方形/圆形                        | string | `round`   |
+| avatar-size       | 头像大小                                   | string | `50px`    |
+| round  | 标题/段落是否采用圆角风格                                | boolean | `false`  |
+| row    | 设置段落行数                                           | string | `1`       |
+| title  | 是否显示段落标题                                        | boolean | `true`   |
 
 
 ### Slots