Browse Source

docs: icon link edit

richard1015 3 years ago
parent
commit
0dc9e9b892

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

@@ -208,8 +208,8 @@ You can center the left and right contents of the cell vertically through the 'c
 | desc                    | Description                                                                                              | String           | -                |
 | desc-text-align         | Right description text alignment [text-align](https://www.w3school.com.cn/cssref/pr_text_text-align.asp) | String           | right            |
 | is-link                 | Whether to show the right arrow and turn on click feedback                                               | Boolean          | false            |
-| icon                    | Left [icon name](#/icon) or image url                                                                    | String           | -                |
-| right-icon`v3.2.1`      | Right [icon name](#/icon) or image url                                                                   | String           | right            |
+| icon                    | Left [icon name](#/en-US/component/icon) or image url                                                                    | String           | -                |
+| right-icon`v3.2.1`      | Right [icon name](#/en-US/component/icon) or image url                                                                   | String           | right            |
 | round-radius            | Corner radius                                                                                            | Number           | 6px              |
 | url                     | Link URL                                                                                                 | String           | -                |
 | to                      | Target route of the link, same as to of vue-router                                                       | String | Object | -                |

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

@@ -211,8 +211,8 @@ app.use(Icon)
 | desc                    | 右侧描述                                                                                       | String           | -                |
 | desc-text-align         | 右侧描述文本对齐方式 [text-align](https://www.w3school.com.cn/cssref/pr_text_text-align.asp)   | String           | right            |
 | is-link                 | 是否展示右侧箭头并开启点击反馈                                                                 | Boolean          | false            |
-| icon                    | 左侧 [图标名称](#/icon) 或图片链接                                                             | String           | -                |
-| right-icon`v3.2.1`      | 右侧箭头 [图标名称](#/icon) 或图片链接                                                         | String           | right            |
+| icon                    | 左侧 [图标名称](#/zh-CN/component/icon) 或图片链接                                                             | String           | -                |
+| right-icon`v3.2.1`      | 右侧箭头 [图标名称](#/zh-CN/component/icon) 或图片链接                                                         | String           | right            |
 | round-radius            | 圆角半径                                                                                       | Number           | 6px              |
 | url `小程序不支持`      | 点击后跳转的链接地址                                                                           | String           | -                |
 | to `小程序不支持`       | 点击后跳转的目标路由对象,同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) 属性 | String | Object | -                |

+ 4 - 4
src/packages/__VUE/checkbox/doc.md

@@ -381,10 +381,10 @@ app.use(Icon);
 | v-model | 是否处于选中状态 | Boolean | `false`
 | disabled | 是否禁用选择 | Boolean | `false`
 | text-position | 文本所在的位置,可选值:`left`,`right` | String | `right`
-| icon-size | [图标尺寸](#/icon) | String、Number | `18`
-| icon-name | [图标名称](#/icon),选中前(建议和`icon-active-name`一起修改) | String | `'check-normal'`
-| icon-active-name | [图标名称](#/icon),选中后(建议和`icon-name`一起修改) | String | `'checked'`
-| icon-indeterminate-name | [图标名称](#/icon),半选状态 | String | `'check-disabled'`
+| icon-size | [图标尺寸](#/zh-CN/component/icon) | String、Number | `18`
+| icon-name | [图标名称](#/zh-CN/component/icon),选中前(建议和`icon-active-name`一起修改) | String | `'check-normal'`
+| icon-active-name | [图标名称](#/zh-CN/component/icon),选中后(建议和`icon-name`一起修改) | String | `'checked'`
+| icon-indeterminate-name | [图标名称](#/zh-CN/component/icon),半选状态 | String | `'check-disabled'`
 | icon-class-prefix | 自定义 icon 类名前缀,用于使用自定义图标        | String                  | `nut-icon` |
 | icon-font-class-name | 自定义 icon 字体基础类名        | String                  | `nutui-iconfont` |
 | label | 复选框的文本内容 | String | -

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

@@ -178,7 +178,7 @@ app.use(GridItem);
 | 参数                  | 说明                                                                                     | 类型               | 默认值      |
 |----------------------|-----------------------------------------------------------------------------------------|--------------------|------------|
 | text                 | 文字                                                                                     | string             | -          |
-| icon                 | [图标名称](#/icon) 或图片链接                                                              | string             | -          |
+| icon                 | [图标名称](#/zh-CN/component/icon) 或图片链接                                                              | string             | -          |
 | icon-size            | 图标大小,如 `20px` `2em` `2rem`                                                          | number \| string   | `28px`     |
 | icon-color           | 图标颜色                                                                                  | string            | -           |
 | url `小程序不支持`     | 点击后跳转的链接地址                                                                        | string            | -           |

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

@@ -257,9 +257,9 @@ Scrolling to the bottom of the list automatically loads more data.
 | container-id     | When useWindow is false, set the node ID by default                                                                | String  | `''`             |
 | load-more-txt    | "No more" text                                                                                                     | String  | 'Oops, this is the bottom'|
 | is-open-refresh  | Enable pull refresh                                                                                                | Boolean | `false`          |
-| pull-icon        | Pull refresh[图标名称](#/icon)                                                                                       | String  | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40/>                |
+| pull-icon        | Pull refresh[图标名称](#/zh-CN/component/icon)                                                                                       | String  | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40/>                |
 | pull-txt         | Pull refresh text                                                                                                   | String  |`Loose to refresh`|
-| load-icon        | Pull on loading[图标名称](#/icon)                                                                                    | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40 />                |
+| load-icon        | Pull on loading[图标名称](#/zh-CN/component/icon)                                                                                    | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40 />                |
 | load-txt         | Pull on loading text                                                                                                | String  | `Loading...`      |
 
 ### Events

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

@@ -252,9 +252,9 @@
 | container-id          | 在 useWindow 属性为 false 的时候,自定义设置节点ID                        | String | `''`            |
 | load-more-txt          | “没有更多数”据展示文案                        | String | `'哎呀,这里是底部了啦'`            |
 | is-open-refresh        | 是否开启下拉刷新                         | Boolean | `false`                |
-| pull-icon        | 下拉刷新[图标名称](#/icon)                        | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40/>                |
+| pull-icon        | 下拉刷新[图标名称](#/zh-CN/component/icon)                        | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40/>                |
 | pull-txt        | 下拉刷新提示文案                         | String | `松手刷新`                |
-| load-icon        | 上拉加载[图标名称](#/icon)                       | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40 />                |
+| load-icon        | 上拉加载[图标名称](#/zh-CN/component/icon)                       | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40 />                |
 | load-txt        | 上拉加载提示文案                         | String | `加载中...`                |
 
 ### Events

+ 2 - 2
src/packages/__VUE/infiniteloading/doc.taro.md

@@ -100,9 +100,9 @@ setup() {
 | container-id          | 必填,设置滚动节点ID                        | String | `''`            |
 | load-more-txt          | “没有更多数”据展示文案                        | String | `'哎呀,这里是底部了啦'`            |
 | is-open-refresh        | 是否开启下拉刷新                         | Boolean | `false`                |
-| pull-icon        | 下拉刷新[图标名称](#/icon)                        | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40/>                |
+| pull-icon        | 下拉刷新[图标名称](#/zh-CN/component/icon)                        | String | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40/>                |
 | pull-txt        | 下拉刷新提示文案                         | String | `松手刷新`                |
-| load-icon        | 上拉加载[图标名称](#/icon)                       | Boolean | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40 />                |
+| load-icon        | 上拉加载[图标名称](#/zh-CN/component/icon)                       | Boolean | <img src="https://img10.360buyimg.com/imagetools/jfs/t1/169863/6/4565/6306/60125948E7e92774e/40b3a0cf42852bcb.png" width=40 />                |
 | load-txt        | 上拉加载提示文案                         | String | `加载中...`                |
 
 ### Events

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

@@ -499,10 +499,10 @@ The user can enter content in the text box. Configure the icons on both sides of
 | autofocus    | Whether to auto focus, unsupported in iOS     | Boolean        | `false` |
 | max-length   | Max length of value                  | String、Number  | -       |
 | clearable    | Whether to be clearable              | Boolean        | `false`  |
-| clear-icon   | Clear Icon name, [name of icon](#/icon)           | String        | `mask-close`  |
+| clear-icon   | Clear Icon name, [name of icon](#/en-US/component/icon)           | String        | `mask-close`  |
 | clear-size   | Clear Icon `font-size`               | String        | `14`  |
-| left-icon    | Left side Icon name, [name of icon](#/icon) | String        | - |
-| right-icon   | Right side Icon name, [name of icon](#/icon) | String        | - |
+| left-icon    | Left side Icon name, [name of icon](#/en-US/component/icon) | String        | - |
+| right-icon   | Right side Icon name, [name of icon](#/en-US/component/icon) | String        | - |
 | left-icon-size    | Left side Icon `font-size`    | String        | `14`  |
 | right-icon-size   | Right side Icon `font-size`   | String        | `14`  |
 | show-word-limit | Whether to show word limit, need to set the `max-length` prop | Boolean | `false`  |

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

@@ -500,10 +500,10 @@ app.use(Icon);
 | autofocus    | 是否自动获得焦点,iOS 系统不支持该属性     | Boolean        | `false` |
 | max-length      | 限制最长输入字符                       | String、Number  | -       |
 | clearable    | 展示清除 Icon                         | Boolean        | `false`  |
-| clear-icon   | 清除图标 Icon 名称或图片链接,[可参考 Icon 组件的 name 属性](#/icon)   | String        | `mask-close`  |
+| clear-icon   | 清除图标 Icon 名称或图片链接,[可参考 Icon 组件的 name 属性](#/zh-CN/component/icon)   | String        | `mask-close`  |
 | clear-size   | 清除图标的 `font-size` 大小           | String        | `14`  |
-| left-icon    | 左侧 Icon 名称或图片链接,[可参考 Icon 组件的 name 属性](#/icon) | String        | - |
-| right-icon   | 右侧 Icon 名称或图片链接,[可参考 Icon 组件的 name 属性](#/icon) | String        | - |
+| left-icon    | 左侧 Icon 名称或图片链接,[可参考 Icon 组件的 name 属性](#/zh-CN/component/icon) | String        | - |
+| right-icon   | 右侧 Icon 名称或图片链接,[可参考 Icon 组件的 name 属性](#/zh-CN/component/icon) | String        | - |
 | left-icon-size    | 左侧 Icon 的 `font-size` 大小           | String        | `14`  |
 | right-icon-size   | 右侧 Icon 的 `font-size` 大小           | String        | `14`  |
 | show-word-limit | 是否显示限制最长输入字符,需要设置 `max-length` 属性 | Boolean | `false`  |

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

@@ -206,9 +206,9 @@ app.use(Icon);
 | 字段             | 说明                                                         | 类型                    | 默认值            |
 |------------------|--------------------------------------------------------------|-------------------------|-------------------|
 | disabled         | 是否禁用选择                                                 | Boolean                 | `false`           |
-| icon-size        | [图标尺寸](#/icon)                                           | String、Number          | `18`              |
-| icon-name        | [图标名称](#/icon),选中前(建议和`icon-active-name`一起修改) | String                  | `'check-normal'`  |
-| icon-active-name | [图标名称](#/icon),选中后(建议和`icon-name`一起修改)        | String                  | `'check-checked'` |
+| icon-size        | [图标尺寸](#/zh-CN/component/icon)                                           | String、Number          | `18`              |
+| icon-name        | [图标名称](#/zh-CN/component/icon),选中前(建议和`icon-active-name`一起修改) | String                  | `'check-normal'`  |
+| icon-active-name | [图标名称](#/zh-CN/component/icon),选中后(建议和`icon-name`一起修改)        | String                  | `'check-checked'` |
 | icon-class-prefix | 自定义 icon 类名前缀,用于使用自定义图标        | String                  | `nut-icon` |
 | icon-font-class-name | 自定义 icon 字体基础类名        | String                  | `nutui-iconfont` |
 | label            | 单选框标识                                                   | String、Number、Boolean | -                 |

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

@@ -204,8 +204,8 @@ export default {
 | icon-size          | Star size                                                                        | Number  | 18               |
 | active-color       | Icon selection color                                                             | String  | #fa200c          |
 | void-color         | Icon unselected color                                                            | String  | #ccc             |
-| unchecked-icon     | Use icon (unchecked)[icon name](#/icon)                                          | String  | star-n           |
-| checked-icon       | Use icon (checked)[icon name](#/icon)                                            | String  | star-fill-n      |
+| unchecked-icon     | Use icon (unchecked)[icon name](#/en-US/component/icon)                                          | String  | star-n           |
+| checked-icon       | Use icon (checked)[icon name](#/en-US/component/icon)                                            | String  | star-fill-n      |
 | font-class-name    | Custom icon font base class name                                                 | String  | `nutui-iconfont` |
 | class-prefix       | Custom icon class name prefix for using custom icons                             | String  | `nut-icon`       |
 | allow-half         | half star                                                                        | Boolean | false            |

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

@@ -205,8 +205,8 @@ export default {
 | icon-size                          | star 大小                                 | Number  | 18               |
 | active-color                       | 图标选中颜色                              | String  | #fa200c          |
 | void-color                         | 图标未选中颜色                            | String  | #ccc             |
-| unchecked-icon                     | 使用图标(未选中)[图标名称](#/icon)        | String  | star-n           |
-| checked-icon                       | 使用图标(选中)[图标名称](#/icon)          | String  | star-fill-n      |
+| unchecked-icon                     | 使用图标(未选中)[图标名称](#/zh-CN/component/icon)        | String  | star-n           |
+| checked-icon                       | 使用图标(选中)[图标名称](#/zh-CN/component/icon)          | String  | star-fill-n      |
 | font-class-name                    | 自定义icon 字体基础类名                   | String  | `nutui-iconfont` |
 | class-prefix                       | 自定义icon 类名前缀,用于使用自定义图标   | String  | `nut-icon`       |
 | allow-half                         | 是否半星                                  | Boolean | false            |

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

@@ -169,9 +169,9 @@ app.use(Switch);
 | v-model        | Status of Switch       | Boolean | String | Number | `false`  |
 | disable        | Disable status         | Boolean | `false`               |
 | loading        | Loading status         | Boolean | `false`               |
-| name           | [Name of icon](#/icon) | String | `loading`               |
-| color          | [Color of icon](#/icon),only takes effect in `loading` state | String | -     |
-| size           | [Size of icon](#/icon),only takes effect in `loading` state  | String | Number | `12px`   |
+| name           | [Name of icon](#/en-US/component/icon) | String | `loading`               |
+| color          | [Color of icon](#/en-US/component/icon),only takes effect in `loading` state | String | -     |
+| size           | [Size of icon](#/en-US/component/icon),only takes effect in `loading` state  | String | Number | `12px`   |
 | active-color   | Background color when active | String  | `#fa2c19`    |
 | inactive-color | Background color when inactive | String  | `#ebebeb` | 
 | active-text    | Word description when active   | String  | -         |

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

@@ -169,9 +169,9 @@ app.use(Switch);
 | v-model        | 开关状态         | Boolean | String | Number | `false`               |
 | disable        | 禁用状态         | Boolean | `false`               |
 | loading        | 加载状态         | Boolean | `false`               |
-| name        | [图标名称](#/icon)         | String | `loading`               |
-| color        | [图标颜色](#/icon),仅在`loading`状态下生效          | String | -               |
-| size        | [图标尺寸](#/icon),仅在`loading`状态下生效          | String | Number | `12px`               |
+| name        | [图标名称](#/zh-CN/component/icon)         | String | `loading`               |
+| color        | [图标颜色](#/zh-CN/component/icon),仅在`loading`状态下生效          | String | -               |
+| size        | [图标尺寸](#/zh-CN/component/icon),仅在`loading`状态下生效          | String | Number | `12px`               |
 | active-color   | 打开时的背景颜色 | String  | `#fa2c19`    |
 | inactive-color | 关闭时的背景颜色 | String  | `#ebebeb` |
 | active-text    | 打开时文字描述   | String  | -                     |

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

@@ -267,7 +267,7 @@ app.use(TabbarItem);
 |-----------|-------------------------------------------|--------|--------|
 | tab-title | 标签页的标题                              | string | --    |
 | name| 标签名称,作为匹配的标识符                             | string | 当前标签的索引值   |
-| icon      | 标签页显示的[图标名称](#/icon)  | string | --     |
+| icon      | 标签页显示的[图标名称](#/zh-CN/component/icon)  | string | --     |
 | font-class-name | 自定义icon 字体基础类名     | string           | `nutui-iconfont` |
 | class-prefix | 自定义icon 类名前缀,用于使用自定义图标     | string           | `nut-icon` |
 | img      | 标签页显示图片链接 | String | --     |

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

@@ -380,8 +380,8 @@ export default {
 | accept            | File types that can be accepted. See [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept)       | String                            | *                |
 | headers           | Set request headers                                                                                                                              | Object                            | {}               |
 | data              | Uploading extra params or function which can return uploading extra params                                                                       | Object                            | {}               |
-| upload-icon       | Upload area [icon name](#/icon) or image link                                                                                                    | String                            | "photograph"     |
-| upload-icon-size  | Upload area [icon size] (#/icon) size, such as `20px` `2em` `2rem`                                                                               | String or Number                  | -                |
+| upload-icon       | Upload area [icon name](#/en-US/component/icon) or image link                                                                                                    | String                            | "photograph"     |
+| upload-icon-size  | Upload area [icon size] (#/en-US/component/icon) size, such as `20px` `2em` `2rem`                                                                               | String or Number                  | -                |
 | xhr-state         | The success status (status) value of the interface response                                                                                      | Number                            | 200              |
 | with-credentials  | The ajax upload with cookie sent                                                                                                                 | Boolean                           | false            |
 | multiple          | Whether to support multiple file selection                                                                                                       | Boolean                           | false            |

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

@@ -380,8 +380,8 @@ export default {
 | accept                    | 允许上传的文件类型,[详细说明](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B) | String                            | *                |
 | headers                   | 设置上传的请求头部                                                                                                                                                                     | Object                            | {}               |
 | data                      | 附加上传的信息 formData                                                                                                                                                                | Object                            | {}               |
-| upload-icon               | 上传区域[图标名称](#/icon)或图片链接                                                                                                                                                   | String                            | "photograph"     |
-| upload-icon-size          | 上传区域[图标尺寸](#/icon)大小,如 `20px` `2em` `2rem`                                                                                                                                 | String or Number                  | -                |
+| upload-icon               | 上传区域[图标名称](#/zh-CN/component/icon)或图片链接                                                                                                                                                   | String                            | "photograph"     |
+| upload-icon-size          | 上传区域[图标尺寸](#/zh-CN/component/icon)大小,如 `20px` `2em` `2rem`                                                                                                                                 | String or Number                  | -                |
 | xhr-state                 | 接口响应的成功状态(status)值                                                                                                                                                         | Number                            | 200              |
 | with-credentials          | 支持发送 cookie 凭证信息                                                                                                                                                               | Boolean                           | false            |
 | multiple                  | 是否支持文件多选                                                                                                                                                                       | Boolean                           | false            |

+ 2 - 2
src/packages/__VUE/uploader/doc.taro.md

@@ -246,8 +246,8 @@ setup() {
 | size-type                 | 是否压缩所选文件[详细说明](https://developers.weixin.qq.com/miniprogram/dev/api/media/image/wx.chooseImage.html)       | String                            | ['original','compressed'] |
 | headers                   | 设置上传的请求头部                                                                                                     | Object                            | {}                        |
 | data                      | 附加上传的信息 formData                                                                                                | Object                            | {}                        |
-| upload-icon               | 上传区域[图标名称](#/icon)或图片链接                                                                                   | String                            | "photograph"              |
-| upload-icon-size          | 上传区域[图标尺寸](#/icon)大小,如 `20px` `2em` `2rem`                                                                 | String or Number                  | -                         |
+| upload-icon               | 上传区域[图标名称](#/zh-CN/component/icon)或图片链接                                                                                   | String                            | "photograph"              |
+| upload-icon-size          | 上传区域[图标尺寸](#/zh-CN/component/icon)大小,如 `20px` `2em` `2rem`                                                                 | String or Number                  | -                         |
 | xhr-state                 | 接口响应的成功状态(status)值                                                                                         | Number                            | 200                       |
 | disabled                  | 是否禁用文件上传                                                                                                       | Boolean                           | false                     |
 | multiple`v2.3.4`                  | 是否支持文件多选                                                                                                       | Boolean                           | true            |