Icon 图标
基于字体的图标集,包含了大多数常见场景的图标。
平台差异说明
| App(vue) | App(nvue) | H5 | 小程序 |
|---|---|---|---|
| √ | √ | √ | √ |
基本使用
通过<up-icon>形式来调用,设置name参数为图标名即可。其中color默认为#606266,size默认为16px
html
<up-icon name="photo"></up-icon>修改图标的样式
- 通过
color参数修改图标的颜色 - 通过
size参数修改图标的大小,单位为px
html
<up-icon name="photo" color="#2979ff" size="28"></up-icon>图片图标
这里说的图片图标,指的是小图标,起作用定位为"icon"图标作用,而非大尺寸的图片展示场景,理论上,这个小图标应该为png格式的正方形图标。
上面说到,给组件的name参数传入一个图片的名称即可显示字体图标,这些名称中不能带有/斜杠符号,否则会被认为是传入了图片图标,同时,size参数 也被设置为这个图片图标的宽度,由于是图片,诸如颜色color等参数都会失效。
html
<up-icon label="uview-ultra" size="40" name="https://cdn.uviewui.com/uview/example/button.png"></up-icon>右侧演示页面源代码地址
API
Props
| 参数 | 说明 | 类型 | 默认值 | 可选值 |
|---|---|---|---|---|
| name | 图标名称,见示例图标集,如名称带有/,会被认为是图片图标 | String | - | - |
| color | 图标颜色 | String | color['up-content-color'] | - |
| size | 图标字体大小,单位默认px | String | Number | 16px | - |
| bold | 是否显示粗体 | Boolean | false | - |
| index | 一个用于区分多个图标的值,点击图标时通过click事件传出 | String | Number | - | - |
| hoverClass | 图标按下去的样式类,用法同uni的view组件的hover-class参数,详见:hover-class | String | - | - |
| customPrefix(暂不可用) | 自定义字体图标库时,需要写上此值,详见:扩展自定义图标库 | String | uicon | - |
| label | 图标右侧/下方的label文字 | String | Number | - | - |
| labelPos | label相对于图标的位置 | String | right | bottom / top / left |
| labelSize | label字体大小,单位默认px | String | Number | 15px | - |
| labelColor | label字体颜色 | String | color['up-content-color'] | - |
| space | label与图标的距离,单位默认px | String | Number | 3px | - |
| imgMode | 图片裁剪、缩放的模式,image组件原生属性,详见:image | String | - | - |
| width | name为图片路径时图片的宽度,单位默认px | String | Number | - | - |
| height | name为图片路径时图片的高度,单位默认px | String | Number | - | - |
| top | 图标到顶部的距离,如果某些场景,如果图标没有垂直居中,可以调整此参数,单位默认px | String | Number | 0 | - |
| stop | 是否阻止事件传播 | Boolean | false | - |
Events
| 事件名 | 说明 | 回调参数 | 版本 |
|---|---|---|---|
| click | 点击图标时触发 | index: 通过props传递的index值 | - |