u-icon.vue 7.5 KB

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