Browse Source

fix: layout、notify 文档修改

Ymm0008 3 years ago
parent
commit
fc9a8bbcc3

+ 17 - 17
src/packages/__VUE/layout/doc.en-US.md

@@ -232,29 +232,29 @@ The Layout component provides a 24-column grid, by adding the span attribute on
 
 ### Row Props
 
-| Attribute | Description | Type   | Default
-|----- | ----- | ----- | ----- 
-| type | The optional value is flex | String | -
-| gutter | Spacing between column elements( in PX ) | String、Number | -
-| justify | Flex spindle alignment, optional values are start end center space-around space-between space-evenly | String | start
-| align | Flex cross axis alignment, optional values are flex-start center flex-end | String | flex-start
-| flex-wrap | Whether flex breaks a line. The optional values are nowrap wrap reverse | String | nowrap
+| Field | Description | Type | Default
+|----- | ----- | ----- | -----
+| type | layout method, optional value is `flex` | string | `-`
+| gutter | spacing between column elements (in `px`) | string \| number | `-`
+| justify | Flex main axis alignment, optional values are `start` `end` `center` `space-around` `space-between` `space-evenly` | string | `start`
+| align | Flex cross axis alignment, optional values are `flex-start` `center` `flex-end` | string | `flex-start`
+| flex-wrap | Whether flex wraps, optional values are `nowrap` `wrap` `reverse` | string | `nowrap`
 
 ### Col Props
 
-| Attribute | Description | Type   | Default
-|----- | ----- | ----- | ----- 
-| span | Column element width(There are 24 copies in total. For example, if you set 3 in a row, the span value is 8) | String、Number | 24
-| offset | Column element offset distance | String、Number | 0
+| Field | Description | Type | Default
+|----- | ----- | ----- | -----
+| span | column element width (divided into 24 parts in total, for example, if there are 3 in a row, then the span value is 8) | string \| number | `24`
+| offset | column element offset distance | string \| number | `0`
 
 ### Row Events
 
-| Attribute | Description | callback
-|----- | ----- | ----- 
-| click | Triggered when clicked | event: MouseEvent
+| field | description | callback parameter
+|----- | ----- | -----
+| click | Triggered when clicked | `event: MouseEvent`
 
 ### Col Events
 
-| Attribute | Description | Callback Arguments
-|----- | ----- | ----- 
-| click | Triggered when clicked | event: MouseEvent
+| field | description | callback parameter
+|----- | ----- | -----
+| click | Triggered when clicked | `event: MouseEvent`

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

@@ -228,27 +228,27 @@ Layout 组件提供 24列栅格,通过在 Col 上添加 span 属性设置列
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
-| type | 布局方式,可选值为flex | String | -
-| gutter | 列元素之间的间距(单位为px) | String、Number | -
-| justify | Flex 主轴对齐方式,可选值为 start end center space-around space-between space-evenly | String | start
-| align | Flex 交叉轴对齐方式,可选值为 flex-start center flex-end | String | flex-start
-| flex-wrap | Flex是否换行,可选值为 nowrap wrap reverse | String | nowrap
+| type | 布局方式,可选值为 `flex` | string | `-`
+| gutter | 列元素之间的间距(单位为`px`) | string \| number | `-`
+| justify | Flex 主轴对齐方式,可选值为 `start` `end` `center` `space-around` `space-between` `space-evenly` | string | `start`
+| align | Flex 交叉轴对齐方式,可选值为 `flex-start` `center` `flex-end` | string | `flex-start`
+| flex-wrap | Flex 是否换行,可选值为 `nowrap` `wrap` `reverse` | string | `nowrap`
 
 ### Col Props
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
-| span | 列元素宽度(共分为24份,例如设置一行3个,那么span值为8) | String、Number | 24
-| offset | 列元素偏移距离 | String、Number | 0
+| span | 列元素宽度(共分为24份,例如设置一行3个,那么span值为8) | string \| number | `24`
+| offset | 列元素偏移距离 | string \| number | `0`
 
 ### Row Events
 
 | 字段 | 说明 | 回调参数
 |----- | ----- | ----- 
-| click | 点击时触发 | event: MouseEvent
+| click | 点击时触发 | `event: MouseEvent`
 
 ### Col Events
 
 | 字段 | 说明 | 回调参数
 |----- | ----- | ----- 
-| click | 点击时触发 | event: MouseEvent
+| click | 点击时触发 | `event: MouseEvent`

+ 9 - 9
src/packages/__VUE/layout/doc.taro.md

@@ -228,27 +228,27 @@ Layout 组件提供 24列栅格,通过在 Col 上添加 span 属性设置列
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
-| type | 布局方式,可选值为flex | String | -
-| gutter | 列元素之间的间距(单位为px) | String、Number | -
-| justify | Flex 主轴对齐方式,可选值为 start end center space-around space-between space-evenly | String | start
-| align | Flex 交叉轴对齐方式,可选值为 flex-start center flex-end | String | flex-start
-| flex-wrap | Flex是否换行,可选值为 nowrap wrap reverse | String | nowrap
+| type | 布局方式,可选值为 `flex` | string | `-`
+| gutter | 列元素之间的间距(单位为`px`) | string \| number | `-`
+| justify | Flex 主轴对齐方式,可选值为 `start` `end` `center` `space-around` `space-between` `space-evenly` | string | `start`
+| align | Flex 交叉轴对齐方式,可选值为 `flex-start` `center` `flex-end` | string | `flex-start`
+| flex-wrap | Flex 是否换行,可选值为 `nowrap` `wrap` `reverse` | string | `nowrap`
 
 ### Col Props
 
 | 字段 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
-| span | 列元素宽度(共分为24份,例如设置一行3个,那么span值为8) | String、Number | 24
-| offset | 列元素偏移距离 | String、Number | 0
+| span | 列元素宽度(共分为24份,例如设置一行3个,那么span值为8) | string \| number | `24`
+| offset | 列元素偏移距离 | string \| number | `0`
 
 ### Row Events
 
 | 字段 | 说明 | 回调参数
 |----- | ----- | ----- 
-| click | 点击时触发 | event: MouseEvent
+| click | 点击时触发 | `event: MouseEvent`
 
 ### Col Events
 
 | 字段 | 说明 | 回调参数
 |----- | ----- | ----- 
-| click | 点击时触发 | event: MouseEvent
+| click | 点击时触发 | `event: MouseEvent`

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

@@ -167,13 +167,13 @@ export default {
     
 | Attribute  | Description                                              | Type          | Default  |
 |------------|----------------------------------------------------------|---------------|----------|
-| type       | The information type of the prompt, the optional values are `primary` `success` `danger` `warning`      | String        | `danger` |
-| message    | Display copy, support line feed through \n              | Boolean       | false    |
-| 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        |
-| position | custom position, optional values are `top` `bottom` `left` `right` `center` | String | `top` |
+| type       | The information type of the prompt, the optional values are `primary` `success` `danger` `warning`      | string        | `danger` |
+| message    | Display copy, support line feed through \n              | boolean       | `false`    |
+| 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 `       |
+| position | custom position, optional values are `top` `bottom` `left` `right` `center` | string | `top` |
 
 > Component call is supported after version 'v3.1.20'.
 
@@ -181,8 +181,8 @@ export default {
 
 | Event  | Description                    | Arguments |
 |--------|--------------------------------|-----------|
-| click  | Emitted when notify is clicked | -         |
-| closed | Emitted when notify is closed  | -         |
+| click  | Emitted when notify is clicked | `-`         |
+| closed | Emitted when notify is closed  | `-`         |
 
 ## Theming
 
@@ -190,16 +190,16 @@ 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-notify-text-color| _var(--nut-white)_  | -  |
-|  --nut-notify-padding| _12px 0_  | -  |
-|  --nut-notify-font-size| _14px_  | -  |
-|  --nut-notify-height| _44px_  | -  |
-|  --nut-notify-line-height| _auto_  | -  |
-|  --nut-notify-base-background-color| _linear-gradient(135deg,var(--nut-primary-color) 0%,var(--nut-primary-color-end) 100%)_  | -  |
-|  --nut-notify-primary-background-color| _linear-gradient(315deg, rgba(73, 143, 242, 1) 0%, rgba(73, 101, 242, 1) 100%)_  | -  |
-|  --nut-notify-success-background-color| _linear-gradient(135deg,rgba(38, 191, 38, 1) 0%,rgba(39, 197, 48, 1) 45%,rgba(40, 207, 63, 1) 83%,rgba(41, 212, 70, 1) 100%)_  | -  |
-|  --nut-notify-danger-background-color| _rgba(250, 50, 25, 1)_  | -  |
-|  --nut-notify-warning-background-color| _linear-gradient(135deg, rgba(255, 93, 13, 1) 0%, rgba(255, 154, 13, 1) 100%)_  | -  |
+| Name | Default Value | 
+| --------------------------------------- | -------------------------- |
+|  --nut-notify-text-color| _var(--nut-white)_  |
+|  --nut-notify-padding| _12px 0_  |
+|  --nut-notify-font-size| _14px_  |
+|  --nut-notify-height| _44px_  |
+|  --nut-notify-line-height| _auto_  |
+|  --nut-notify-base-background-color| _linear-gradient(135deg,var(--nut-primary-color) 0%,var(--nut-primary-color-end) 100%)_  |
+|  --nut-notify-primary-background-color| _linear-gradient(315deg, rgba(73, 143, 242, 1) 0%, rgba(73, 101, 242, 1) 100%)_  |
+|  --nut-notify-success-background-color| _linear-gradient(135deg,rgba(38, 191, 38, 1) 0%,rgba(39, 197, 48, 1) 45%,rgba(40, 207, 63, 1) 83%,rgba(41, 212, 70, 1) 100%)_  |
+|  --nut-notify-danger-background-color| _rgba(250, 50, 25, 1)_  |
+|  --nut-notify-warning-background-color| _linear-gradient(135deg, rgba(255, 93, 13, 1) 0%, rgba(255, 154, 13, 1) 100%)_  |
     

+ 14 - 14
src/packages/__VUE/notify/doc.md

@@ -161,10 +161,10 @@ export default {
 |------------|-------------------------------------------------------|---------------|----------|
 | type       | 提示的信息类型,可选值为`primary` `success` `danger` `warning` | string        | `danger` |
 | message    | 展示文案,支持通过\n换行                              | boolean       | `false`    |
-| duration   | 展示时长(ms),值为 0 时,notify 不会消失              | number        | `3000`     |
+| 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
@@ -180,16 +180,16 @@ export default {
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-|  --nut-notify-text-color| _var(--nut-white)_  | -  |
-|  --nut-notify-padding| _12px 0_  | -  |
-|  --nut-notify-font-size| _14px_  | -  |
-|  --nut-notify-height| _44px_  | -  |
-|  --nut-notify-line-height| _auto_  | -  |
-|  --nut-notify-base-background-color| _linear-gradient(135deg,var(--nut-primary-color) 0%,var(--nut-primary-color-end) 100%)_  | -  |
-|  --nut-notify-primary-background-color| _linear-gradient(315deg, rgba(73, 143, 242, 1) 0%, rgba(73, 101, 242, 1) 100%)_  | -  |
-|  --nut-notify-success-background-color| _linear-gradient(135deg,rgba(38, 191, 38, 1) 0%,rgba(39, 197, 48, 1) 45%,rgba(40, 207, 63, 1) 83%,rgba(41, 212, 70, 1) 100%)_  | -  |
-|  --nut-notify-danger-background-color| _rgba(250, 50, 25, 1)_  | -  |
-|  --nut-notify-warning-background-color| _linear-gradient(135deg, rgba(255, 93, 13, 1) 0%, rgba(255, 154, 13, 1) 100%)_  | -  |
+| 名称                                    | 默认值                     |
+| --------------------------------------- | -------------------------- |
+|  --nut-notify-text-color| _var(--nut-white)_  |
+|  --nut-notify-padding| _12px 0_  |
+|  --nut-notify-font-size| _14px_  |
+|  --nut-notify-height| _44px_  |
+|  --nut-notify-line-height| _auto_  |
+|  --nut-notify-base-background-color| _linear-gradient(135deg,var(--nut-primary-color) 0%,var(--nut-primary-color-end) 100%)_  |
+|  --nut-notify-primary-background-color| _linear-gradient(315deg, rgba(73, 143, 242, 1) 0%, rgba(73, 101, 242, 1) 100%)_  |
+|  --nut-notify-success-background-color| _linear-gradient(135deg,rgba(38, 191, 38, 1) 0%,rgba(39, 197, 48, 1) 45%,rgba(40, 207, 63, 1) 83%,rgba(41, 212, 70, 1) 100%)_  |
+|  --nut-notify-danger-background-color| _rgba(250, 50, 25, 1)_  |
+|  --nut-notify-warning-background-color| _linear-gradient(135deg, rgba(255, 93, 13, 1) 0%, rgba(255, 154, 13, 1) 100%)_  |
     

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

@@ -105,20 +105,20 @@ export default {
     
 | 字段       | 说明                                                  | 类型    | 默认值   |
 |------------|-------------------------------------------------------|---------|----------|
-| type       | 提示的信息类型,可选值为`primary` `success` `danger` `warning` | String        | `danger` |
-| message    | 展示文案,支持通过\n换行                              | Boolean       | false    |
-| duration   | 展示时长(ms),值为 0 时,notify 不会消失              | Number        | 3000     |
-| color      | 字体颜色                                              | String        | 空       |
-| background | 背景颜色                                              | String        | 空       |
-| class-name | 自定义类名                                            | string \| number | 1        |
-| position | 自定义位置,可选值为 `top` `bottom` `left` `right` `center`              | String | `top`        |
+| type       | 提示的信息类型,可选值为`primary` `success` `danger` `warning` | string        | `danger` |
+| message    | 展示文案,支持通过\n换行                              | boolean       | `false`    |
+| duration   | 展示时长(ms),值为 0 时,notify 不会消失              | number        | `3000`     |
+| color      | 字体颜色                                              | string        | `''`      |
+| background | 背景颜色                                              | string        |`''`       |
+| class-name | 自定义类名                                            | string \| number | `1`        |
+| position | 自定义位置,可选值为 `top` `bottom` `left` `right` `center`              | string | `top`        |
 
 ### Events
 
 | 事件名 | 说明         | 回调参数 |
 |--------|--------------|----------|
-| click  | 点击事件回调 |        |
-| closed | 关闭事件回调 |        |
+| click  | 点击事件回调 | `-`       |
+| closed | 关闭事件回调 | `-`       |
 
 ## 主题定制
 
@@ -126,16 +126,16 @@ export default {
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-|  --nut-notify-text-color| _var(--nut-white)_  | -  |
-|  --nut-notify-padding| _12px 0_  | -  |
-|  --nut-notify-font-size| _14px_  | -  |
-|  --nut-notify-height| _44px_  | -  |
-|  --nut-notify-line-height| _auto_  | -  |
-|  --nut-notify-base-background-color| _linear-gradient(135deg,var(--nut-primary-color) 0%,var(--nut-primary-color-end) 100%)_  | -  |
-|  --nut-notify-primary-background-color| _linear-gradient(315deg, rgba(73, 143, 242, 1) 0%, rgba(73, 101, 242, 1) 100%)_  | -  |
-|  --nut-notify-success-background-color| _linear-gradient(135deg,rgba(38, 191, 38, 1) 0%,rgba(39, 197, 48, 1) 45%,rgba(40, 207, 63, 1) 83%,rgba(41, 212, 70, 1) 100%)_  | -  |
-|  --nut-notify-danger-background-color| _rgba(250, 50, 25, 1)_  | -  |
-|  --nut-notify-warning-background-color| _linear-gradient(135deg, rgba(255, 93, 13, 1) 0%, rgba(255, 154, 13, 1) 100%)_  | -  |
+| 名称                                    | 默认值                     | 
+| --------------------------------------- | -------------------------- |
+|  --nut-notify-text-color| _var(--nut-white)_  |
+|  --nut-notify-padding| _12px 0_  |
+|  --nut-notify-font-size| _14px_  |
+|  --nut-notify-height| _44px_  |
+|  --nut-notify-line-height| _auto_  |
+|  --nut-notify-base-background-color| _linear-gradient(135deg,var(--nut-primary-color) 0%,var(--nut-primary-color-end) 100%)_  |
+|  --nut-notify-primary-background-color| _linear-gradient(315deg, rgba(73, 143, 242, 1) 0%, rgba(73, 101, 242, 1) 100%)_  |
+|  --nut-notify-success-background-color| _linear-gradient(135deg,rgba(38, 191, 38, 1) 0%,rgba(39, 197, 48, 1) 45%,rgba(40, 207, 63, 1) 83%,rgba(41, 212, 70, 1) 100%)_  |
+|  --nut-notify-danger-background-color| _rgba(250, 50, 25, 1)_  |
+|  --nut-notify-warning-background-color| _linear-gradient(135deg, rgba(255, 93, 13, 1) 0%, rgba(255, 154, 13, 1) 100%)_  |