u-icon.vue 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. <template>
  2. <view
  3. class="u-icon"
  4. @tap="clickHandler"
  5. :class="['u-icon--' + labelPos]"
  6. >
  7. <image
  8. class="u-icon__img"
  9. v-if="isImg"
  10. :src="name"
  11. :mode="imgMode"
  12. :style="[imgStyle, addStyle(customStyle)]"
  13. ></image>
  14. <text
  15. v-else
  16. class="u-icon__icon"
  17. :class="uClasses"
  18. :style="[iconStyle, addStyle(customStyle)]"
  19. :hover-class="hoverClass"
  20. >{{icon}}</text>
  21. <!-- 这里进行空字符串判断,如果仅仅是v-if="label",可能会出现传递0的时候,结果也无法显示 -->
  22. <text
  23. v-if="label !== ''"
  24. class="u-icon__label"
  25. :style="{
  26. color: labelColor,
  27. fontSize: addUnit(labelSize),
  28. marginLeft: labelPos == 'right' ? addUnit(space) : 0,
  29. marginTop: labelPos == 'bottom' ? addUnit(space) : 0,
  30. marginRight: labelPos == 'left' ? addUnit(space) : 0,
  31. marginBottom: labelPos == 'top' ? addUnit(space) : 0,
  32. }"
  33. >{{ label }}</text>
  34. </view>
  35. </template>
  36. <script>
  37. // 引入图标名称,已经对应的unicode
  38. import icons from './icons';
  39. import { props } from './props';
  40. import config from '../../libs/config/config';
  41. import { mpMixin } from '../../libs/mixin/mpMixin';
  42. import { mixin } from '../../libs/mixin/mixin';
  43. import { addUnit, addStyle } from '../../libs/function/index';
  44. /**
  45. * icon 图标
  46. * @description 基于字体的图标集,包含了大多数常见场景的图标。
  47. * @tutorial https://ijry.github.io/uview-plus/components/icon.html
  48. * @property {String} name 图标名称,见示例图标集
  49. * @property {String} color 图标颜色,可接受主题色 (默认 color['u-content-color'] )
  50. * @property {String | Number} size 图标字体大小,单位px (默认 '16px' )
  51. * @property {Boolean} bold 是否显示粗体 (默认 false )
  52. * @property {String | Number} index 点击图标的时候传递事件出去的index(用于区分点击了哪一个)
  53. * @property {String} hoverClass 图标按下去的样式类,用法同uni的view组件的hoverClass参数,详情见官网
  54. * @property {String} customPrefix 自定义扩展前缀,方便用户扩展自己的图标库 (默认 'uicon' )
  55. * @property {String | Number} label 图标右侧的label文字
  56. * @property {String} labelPos label相对于图标的位置,只能right或bottom (默认 'right' )
  57. * @property {String | Number} labelSize label字体大小,单位px (默认 '15px' )
  58. * @property {String} labelColor 图标右侧的label文字颜色 ( 默认 color['u-content-color'] )
  59. * @property {String | Number} space label与图标的距离,单位px (默认 '3px' )
  60. * @property {String} imgMode 图片的mode
  61. * @property {String | Number} width 显示图片小图标时的宽度
  62. * @property {String | Number} height 显示图片小图标时的高度
  63. * @property {String | Number} top 图标在垂直方向上的定位 用于解决某些情况下,让图标垂直居中的用途 (默认 0 )
  64. * @property {Boolean} stop 是否阻止事件传播 (默认 false )
  65. * @property {Object} customStyle icon的样式,对象形式
  66. * @event {Function} click 点击图标时触发
  67. * @event {Function} touchstart 事件触摸时触发
  68. * @example <u-icon name="photo" color="#2979ff" size="28"></u-icon>
  69. */
  70. export default {
  71. name: 'u-icon',
  72. beforeCreate() {
  73. // #ifdef APP-NVUE
  74. // nvue通过weex的dom模块引入字体,相关文档地址如下:
  75. // https://weex.apache.org/zh/docs/modules/dom.html#addrule
  76. const domModule = weex.requireModule('dom');
  77. domModule.addRule('fontFace', {
  78. 'fontFamily': "uicon-iconfont",
  79. 'src': `url('${config.iconUrl}')`
  80. });
  81. if (config.customIcon.family) {
  82. domModule.addRule('fontFace', {
  83. 'fontFamily': config.customIcon.family,
  84. 'src': `url('${config.customIcon.url}')`
  85. });
  86. }
  87. // #endif
  88. // #ifdef APP || H5 || MP-WEIXIN || MP-ALIPAY
  89. uni.loadFontFace({
  90. family: 'uicon-iconfont',
  91. source: 'url("' + config.iconUrl + '")',
  92. success() {
  93. // console.log('内置字体图标加载成功');
  94. },
  95. fail() {
  96. // console.error('内置字体图标加载出错');
  97. }
  98. });
  99. if (config.customIcon.family) {
  100. uni.loadFontFace({
  101. family: config.customIcon.family,
  102. source: 'url("' + config.customIcon.url + '")',
  103. success() {
  104. // console.log('扩展字体图标加载成功');
  105. },
  106. fail() {
  107. // console.error('扩展字体图标加载出错');
  108. }
  109. });
  110. }
  111. // #endif
  112. // #ifdef APP-NVUE
  113. if (this.customFontFamily) {
  114. domModule.addRule('fontFace', {
  115. 'fontFamily': `${this.customPrefix}-${this.customFontFamily}`,
  116. 'src': `url('${this.customFontUrl}')`
  117. })
  118. }
  119. // #endif
  120. },
  121. data() {
  122. return {
  123. }
  124. },
  125. emits: ['click'],
  126. mixins: [mpMixin, mixin, props],
  127. computed: {
  128. uClasses() {
  129. let classes = []
  130. classes.push(this.customPrefix + '-' + this.name)
  131. // uview-plus内置图标类名为u-iconfont
  132. if (this.customPrefix == 'uicon') {
  133. classes.push('u-iconfont')
  134. } else {
  135. // 不能缺少这一步,否则自定义图标会无效
  136. classes.push(this.customPrefix)
  137. }
  138. // 主题色,通过类配置
  139. if (this.color && config.type.includes(this.color)) classes.push('u-icon__icon--' + this.color)
  140. // 阿里,头条,百度小程序通过数组绑定类名时,无法直接使用[a, b, c]的形式,否则无法识别
  141. // 故需将其拆成一个字符串的形式,通过空格隔开各个类名
  142. //#ifdef MP-ALIPAY || MP-TOUTIAO || MP-BAIDU
  143. classes = classes.join(' ')
  144. //#endif
  145. return classes
  146. },
  147. iconStyle() {
  148. let style = {}
  149. style = {
  150. fontSize: addUnit(this.size),
  151. lineHeight: addUnit(this.size),
  152. fontWeight: this.bold ? 'bold' : 'normal',
  153. // 某些特殊情况需要设置一个到顶部的距离,才能更好的垂直居中
  154. top: addUnit(this.top)
  155. }
  156. if (this.customPrefix !== 'uicon') {
  157. style.fontFamily = this.customPrefix
  158. }
  159. // 非主题色值时,才当作颜色值
  160. if (this.color && !config.type.includes(this.color)) style.color = this.color
  161. return style
  162. },
  163. // 判断传入的name属性,是否图片路径,只要带有"/"均认为是图片形式
  164. isImg() {
  165. return this.name.indexOf('/') !== -1
  166. },
  167. imgStyle() {
  168. let style = {}
  169. // 如果设置width和height属性,则优先使用,否则使用size属性
  170. style.width = this.width ? addUnit(this.width) : addUnit(this.size)
  171. style.height = this.height ? addUnit(this.height) : addUnit(this.size)
  172. return style
  173. },
  174. // 通过图标名,查找对应的图标
  175. icon() {
  176. // 使用自定义图标的时候页面上会把name属性也展示出来,所以在这里处理一下
  177. if (this.customPrefix !== "uicon") {
  178. return config.customIcons[this.name] || this.name;
  179. }
  180. // 如果内置的图标中找不到对应的图标,就直接返回name值,因为用户可能传入的是unicode代码
  181. return icons['uicon-' + this.name] || this.name
  182. }
  183. },
  184. methods: {
  185. addStyle,
  186. addUnit,
  187. clickHandler(e) {
  188. this.$emit('click', this.index, e)
  189. // 是否阻止事件冒泡
  190. this.stop && this.preventEvent(e)
  191. }
  192. }
  193. }
  194. </script>
  195. <style lang="scss" scoped>
  196. // 变量定义
  197. $u-icon-primary: $u-primary !default;
  198. $u-icon-success: $u-success !default;
  199. $u-icon-info: $u-info !default;
  200. $u-icon-warning: $u-warning !default;
  201. $u-icon-error: $u-error !default;
  202. $u-icon-label-line-height:1 !default;
  203. /* #ifdef MP-QQ || MP-TOUTIAO || MP-BAIDU || MP-KUAISHOU || MP-XHS */
  204. // 2025/04/09在App/微信/支付宝/鸿蒙元服务已改用uni.loadFontFace加载字体
  205. @font-face {
  206. font-family: 'uicon-iconfont';
  207. src: url('https://at.alicdn.com/t/font_2225171_8kdcwk4po24.ttf') format('truetype');
  208. }
  209. /* #endif */
  210. .u-icon {
  211. /* #ifndef APP-NVUE */
  212. display: flex;
  213. /* #endif */
  214. align-items: center;
  215. &--left {
  216. flex-direction: row-reverse;
  217. align-items: center;
  218. }
  219. &--right {
  220. flex-direction: row;
  221. align-items: center;
  222. }
  223. &--top {
  224. flex-direction: column-reverse;
  225. justify-content: center;
  226. }
  227. &--bottom {
  228. flex-direction: column;
  229. justify-content: center;
  230. }
  231. &__icon {
  232. font-family: uicon-iconfont;
  233. position: relative;
  234. @include flex;
  235. align-items: center;
  236. &--primary {
  237. color: $u-icon-primary;
  238. }
  239. &--success {
  240. color: $u-icon-success;
  241. }
  242. &--error {
  243. color: $u-icon-error;
  244. }
  245. &--warning {
  246. color: $u-icon-warning;
  247. }
  248. &--info {
  249. color: $u-icon-info;
  250. }
  251. }
  252. &__img {
  253. /* #ifndef APP-NVUE */
  254. height: auto;
  255. will-change: transform;
  256. /* #endif */
  257. }
  258. &__label {
  259. /* #ifndef APP-NVUE */
  260. line-height: $u-icon-label-line-height;
  261. /* #endif */
  262. }
  263. }
  264. </style>