docs: 文案修改 (#1998)

* fix: popover * fix: 代码回退 * feat: 文档修改 * feat: 修改Imagepreview * feat: imagepreview文案修改 * feat: noticebar文案修改 * fix: noticebar小程序不能运行问题修改 * feat: 组件文档修改picker * docs: 文案修改 * docs: countdown * feat: image
jdf2e · Jan 3, 2023 · 4d94960 · 4d94960
1 parent 5120cb4
commit 4d94960
Show file tree

Hide file tree

Showing 8 changed files with 268 additions and 270 deletions.
diff --git a/src/packages/__VUE/address/doc.en-US.md b/src/packages/__VUE/address/doc.en-US.md
@@ -527,20 +527,20 @@ If you want to select a province, you need to set the region ID in the order of
 
 | Attribute            | Description               | Type   | Default  |
 |----- | ----- | ----- | ----- |
-| v-model:visible | Whether to open address | String | ''|
-| type | Choose type: exist/custom/custom2  | String | 'custom'|
-| province | Province data| Array | []|
-| city | City data | Array | []|
-| country | Country data | Array | []|
-| town | Town dta | Array | []|
-| height | Popup height | String、Number | '200px'|
-| exist-address | Exist address list data | Array | []|
-| is-show-custom-address | Whether to change custom address | Boolean | true|
-| custom-address-title  | Custom address title | String | 'Select Region'|
-| exist-address-title|  Exist address title | String | 'Delivery To'|
-| custom-and-exist-title| Custom address and existing address switch button copywriting | String | 'Choose Another Address'|
-| columns-placeholder | Columns placeholder text | String|Array | 'Select'|
-| lock-scroll   | Whether the background is locked   | Boolean        | `true`       |
+| v-model:visible | Whether to open address | string | `''`|
+| type | Choose type: exist/custom/custom2  | string | `custom`|
+| province | Province data| array | `[]`|
+| city | City data | array | `[]`|
+| country | Country data | array | `[]`|
+| town | Town dta | array | `[]`|
+| height | Popup height | string \| number | `200px`|
+| exist-address | Exist address list data | array | `[]`|
+| is-show-custom-address | Whether to change custom address | boolean | `true`|
+| custom-address-title  | Custom address title | string | `Select Region`|
+| exist-address-title|  Exist address title | string | `Delivery To`|
+| custom-and-exist-title| Custom address and existing address switch button copywriting | string | `Choose Another Address`|
+| columns-placeholder | Columns placeholder text | string \| array | `Select`|
+| lock-scroll   | Whether the background is locked   | boolean        | `true`       |
 
 
 ## Event
@@ -563,15 +563,15 @@ If you want to select a province, you need to set the region ID in the order of
 ## selected 
 | Attribute            | Description               | Options   |
 |----- | ----- | ----- |
-| First Option（prevExistAdd） |  Select the previously selected address |  {}|
-| Second Option（nowExistAdd） |  Currently selected address |  {}|
-| Third Option（arr） |  After selecting the existing address list |  {}|
+| First Option（prevExistAdd） |  Select the previously selected address |  `{}`|
+| Second Option（nowExistAdd） |  Currently selected address |  `{}`|
+| Third Option（arr） |  After selecting the existing address list |  `{}`|
 
 ## close 
 | Attribute            | Description               | Options   |
 |----- | ----- | ----- |
 | type | Selected Type  |  exist/custom/custom2|
-| data | Selected Data | {} |
+| data | Selected Data | `{}` |
 
 
 ## Slot
@@ -589,17 +589,17 @@ If you want to select a province, you need to set the region ID in the order of
 
 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-address-region-tab-line| _linear-gradient(90deg, var(--nut-primary-color) 0%, var(--nut-active-color) 100%)_| -    |
-|  --nut-address-icon-color| _var(--nut-primary-color)_     | -    |
-|  --nut-address-header-title-font-size   | _18px_          | -    |
-|  --nut-address-header-title-color| _#262626_    | -    |
-|  --nut-address-region-tab-font-size| _13px_  | -    |
-|  --nut-address-region-tab-color| _#1d1e1e_  | -    |
-|  --nut-address-region-tab-active-item-font-weight| _bold_    | -    |
-|  --nut-address-region-tab-line-border-radius| _0_   | -    |
-|  --nut-address-region-tab-line-opacity| _1_   | -    |
-|  --nut-address-region-item-color| _#333_    | -    |
-|  --nut-address-region-item-font-size| _var(--nut-font-size-1)_   | -    |
-|  --nut-address-item-margin-right| _9px_  | -    |
+| Name | Default Value | 
+| --------------------------------------- | -------------------------- |
+|  --nut-address-region-tab-line| _linear-gradient(90deg, var(--nut-primary-color) 0%, var(--nut-active-color) 100%)_| 
+|  --nut-address-icon-color| _var(--nut-primary-color)_     | 
+|  --nut-address-header-title-font-size   | _18px_          | 
+|  --nut-address-header-title-color| _#262626_    | 
+|  --nut-address-region-tab-font-size| _13px_  | 
+|  --nut-address-region-tab-color| _#1d1e1e_  | 
+|  --nut-address-region-tab-active-item-font-weight| _bold_    | 
+|  --nut-address-region-tab-line-border-radius| _0_   | 
+|  --nut-address-region-tab-line-opacity| _1_   | 
+|  --nut-address-region-item-color| _#333_    | 
+|  --nut-address-region-item-font-size| _var(--nut-font-size-1)_   | 
+|  --nut-address-item-margin-right| _9px_  | 
diff --git a/src/packages/__VUE/address/doc.md b/src/packages/__VUE/address/doc.md
@@ -2,8 +2,6 @@
 
 ### 介绍
 
-
-
 ### 安装
 
 ``` javascript
@@ -84,24 +82,24 @@ app.use(Address);
 
 ### 选择省市区
 
-如果想选中某个省市区，需要在 model-value 中按照 province、city、country、town 的顺序配置想要展示的地区 id 值，并且保证有能查询到对应的省市区数据即可。
+如果想选中某个省市区，需要在 `model-value` 中按照 `province`、`city`、`country`、`town` 的顺序配置想要展示的地区 id 值，并且保证有能查询到对应的省市区数据即可。
 
 :::demo
 ```html
 <template>
-<nut-cell title="选择地址" :desc="text" is-link @click="showAddress"></nut-cell>
-<nut-address
-    v-model="value"
-    v-model:visible="showPopup"
-    :province="province"
-    :city="city"
-    :country="country"
-    :town="town"
-    @change="onChange"
-    @close="close"
-    custom-address-title="请选择所在地区"
-    :columns-placeholder="placeholder"
-></nut-address>
+  <nut-cell title="选择地址" :desc="text" is-link @click="showAddress"></nut-cell>
+  <nut-address
+      v-model="value"
+      v-model:visible="showPopup"
+      :province="province"
+      :city="city"
+      :country="country"
+      :town="town"
+      @change="onChange"
+      @close="close"
+      custom-address-title="请选择所在地区"
+      :columns-placeholder="placeholder"
+  ></nut-address>
 </template>
 <script>
   import { ref,reactive,toRefs } from 'vue';
@@ -545,20 +543,20 @@ app.use(Address);
 
 | 字段 | 说明 | 类型 | 默认值 |
 |----- | ----- | ----- | ----- |
-| v-model:visible | 是否打开地址选择 | String | '' |
-| type | 地址选择类型 exist/custom/custom2  | String | 'custom' |
-| province | 省，每个省的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | Array | [] |
-| city | 市，每个市的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | Array | [] |
-| country | 县，每个县的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | Array | [] |
-| town | 乡/镇，每个乡/镇的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | Array | [] |
-| height | 弹层中内容容器的高度，仅在type="custom2"时有效 | String、Number | '200px' |
-| exist-address | 已存在地址列表，每个地址对象中，必传值provinceName、cityName、countyName、townName、addressDetail、selectedAddress（字段解释见下） | Array | [] |
-| is-show-custom-address | 是否可以切换自定义地址选择，type=‘exist’ 时生效 | Boolean | true |
-| custom-address-title  | 自定义地址选择文案，type='custom' 时生效 | String | '请选择所在地区' |
-| exist-address-title| 已有地址文案 ，type=‘exist’ 时生效| String | '配送至' |
-| custom-and-exist-title| 自定义地址与已有地址切换按钮文案 ，type=‘exist’ 时生效| String | '选择其他地址' |
-| columns-placeholder | 列提示文字 | String|Array | '请选择' |
-| lock-scroll  | 背景是否锁定      | Boolean        | `true`  |
+| v-model:visible | 是否打开地址选择 | string | `''` |
+| type | 地址选择类型 exist/custom/custom2  | string | `custom` |
+| province | 省，每个省的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | array | `[]` |
+| city | 市，每个市的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | array | `[]` |
+| country | 县，每个县的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | array | `[]` |
+| town | 乡/镇，每个乡/镇的对象中，必须有 name 字段，如果类型选择 custom2，必须指定 title 字段为首字母 | array | `[]` |
+| height | 弹层中内容容器的高度，仅在type="custom2"时有效 | string \| number | `200px` |
+| exist-address | 已存在地址列表，每个地址对象中，必传值provinceName、cityName、countyName、townName、addressDetail、selectedAddress（字段解释见下） | array | `[]` |
+| is-show-custom-address | 是否可以切换自定义地址选择，type=‘exist’ 时生效 | boolean | `true` |
+| custom-address-title  | 自定义地址选择文案，type='custom' 时生效 | string | `请选择所在地区` |
+| exist-address-title| 已有地址文案 ，type=‘exist’ 时生效| string | `配送至` |
+| custom-and-exist-title| 自定义地址与已有地址切换按钮文案 ，type=‘exist’ 时生效| string | `选择其他地址` |
+| columns-placeholder | 列提示文字 | string \| array | `请选择` |
+| lock-scroll  | 背景是否锁定      | boolean        | `true`  |
 
   * provinceName 省的名字
   * cityName 市的名字
@@ -570,9 +568,9 @@ app.use(Address);
 ### Events
 | 字段 | 说明 | 回调参数  |
 |----- | ----- | ----- |
-| change | 自定义选择地址时，选择地区时触发 |  参考 onChange |
-| selected | 选择已有地址列表时触发 | 参考 selected |
-| close | 地址选择弹框关闭时触发 | 参考 close |
+| change | 自定义选择地址时，选择地区时触发 |  参考 `onChange` |
+| selected | 选择已有地址列表时触发 | 参考 `selected` |
+| close | 地址选择弹框关闭时触发 | 参考 `close` |
 | close-mask |点击遮罩层或点击右上角叉号关闭时触发 | {closeWay:'mask'/'cross'} |
 | switch-module | 点击‘选择其他地址’或自定义地址选择左上角返回按钮触发 | {type:'exist'/'custom'/'custom2'} |
 
@@ -587,15 +585,15 @@ app.use(Address);
 ### selected 回调参数
 | 参数 | 说明 | 可能值 |
 |----- | ----- | ----- |
-| 第一个参数（prevExistAdd） |  选择前选中的地址 |  {} |
-| 第二个参数（nowExistAdd） |  当前选中的地址 |  {} |
-| 第三个参数（arr） |  选择完之后的已有地址列表（selectedAddress 值发生改变） |  {} |
+| 第一个参数（prevExistAdd） |  选择前选中的地址 |  `{}` |
+| 第二个参数（nowExistAdd） |  当前选中的地址 |  `{}` |
+| 第三个参数（arr） |  选择完之后的已有地址列表（selectedAddress 值发生改变） |  `{}` |
 
 ### close 回调参数
 | 参数 | 说明 | 可能值 |
 |----- | ----- | ----- |
 | type | 地址选择类型 exist/custom/custom2  |  exist/custom/custom2 |
-| data | 选择地址的值,custom 时，addressStr 为选择的地址组合 | {}  |
+| data | 选择地址的值,custom 时，addressStr 为选择的地址组合 | `{}`  |
 
 ### Slots
 | 字段 | 说明 | 
@@ -613,17 +611,17 @@ app.use(Address);
 
 组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-|  --nut-address-region-tab-line| _linear-gradient(90deg, var(--nut-primary-color) 0%, var(--nut-active-color) 100%)_| -    |
-|  --nut-address-icon-color| _var(--nut-primary-color)_     | -    |
-|  --nut-address-header-title-font-size   | _18px_          | -    |
-|  --nut-address-header-title-color| _#262626_    | -    |
-|  --nut-address-region-tab-font-size| _13px_  | -    |
-|  --nut-address-region-tab-color| _#1d1e1e_  | -    |
-|  --nut-address-region-tab-active-item-font-weight| _bold_    | -    |
-|  --nut-address-region-tab-line-border-radius| _0_   | -    |
-|  --nut-address-region-tab-line-opacity| _1_   | -    |
-|  --nut-address-region-item-color| _#333_    | -    |
-|  --nut-address-region-item-font-size| _var(--nut-font-size-1)_   | -    |
-|  --nut-address-item-margin-right| _9px_  | -    |
+| 名称                                    | 默认值                     | 
+| --------------------------------------- | -------------------------- | 
+|  --nut-address-region-tab-line| _linear-gradient(90deg, var(--nut-primary-color) 0%, var(--nut-active-color) 100%)_| 
+|  --nut-address-icon-color| _var(--nut-primary-color)_     | 
+|  --nut-address-header-title-font-size   | _18px_          | 
+|  --nut-address-header-title-color| _#262626_    | 
+|  --nut-address-region-tab-font-size| _13px_  | 
+|  --nut-address-region-tab-color| _#1d1e1e_  | 
+|  --nut-address-region-tab-active-item-font-weight| _bold_    | 
+|  --nut-address-region-tab-line-border-radius| _0_   | 
+|  --nut-address-region-tab-line-opacity| _1_   | 
+|  --nut-address-region-item-color| _#333_    | 
+|  --nut-address-region-item-font-size| _var(--nut-font-size-1)_   | 
+|  --nut-address-item-margin-right| _9px_  |