如何在新项目使用svg-icon组件

最新推荐文章于 2024-02-29 17:57:04 发布

原创最新推荐文章于 2024-02-29 17:57:04 发布 · 243 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#javascript #vue.js #npm

本文介绍了如何在Vue项目中使用svg-sprite-loader处理SVG图标，包括安装依赖、配置webpack、创建和注册SVG组件、验证文件路径，以及在main.js中引入和使用。详细步骤有助于开发者理解和应用SVG图标管理的最佳实践。

1.安装依赖 npm i svg-sprite-loader@4.1.3

2.配置 vue.config.js (补充)

chainWebpack(config) {
   config.module
      .rule('svg')
      .exclude.add(resolve('src/icons'))
      .end()
    config.module
      .rule('icons')
      .test(/\.svg$/)
      .include.add(resolve('src/icons'))
      .end()
      .use('svg-sprite-loader')
      .loader('svg-sprite-loader')
      .options({
        symbolId: 'icon-[name]'
      })
      .end()

}

3.复制/创建文件

①src/icon 保存图标并且注册全局组件

import Vue from 'vue'
import SvgIcon from '@/components/SvgIcon'// svg component

// register globally
Vue.component('svg-icon', SvgIcon)

const req = require.context('./svg', false, /\.svg$/)
const requireAll = requireContext => requireContext.keys().map(requireContext)
requireAll(req)

②组件 componets/SvgIcon/index.vue

<template>
  <div v-if="isExternal" :style="styleExternalIcon" class="svg-external-icon svg-icon" v-on="$listeners" />
  <svg v-else :class="svgClass" aria-hidden="true" v-on="$listeners">
    <use :xlink:href="iconName" />
  </svg>
</template>

<script>
// doc: https://panjiachen.github.io/vue-element-admin-site/feature/component/svg-icon.html#usage
import { isExternal } from '@/utils/validate'
export default {
  name: 'SvgIcon',
  props: {
    iconClass: {
      type: String,
      required: true
    },
    className: {
      type: String,
      default: ''
    }
  },
  computed: {
    isExternal() {
      return isExternal(this.iconClass)
    },
    iconName() {
      return `#icon-${this.iconClass}`
    },
    svgClass() {
      if (this.className) {
        return 'svg-icon ' + this.className
      } else {
        return 'svg-icon'
      }
    },
    styleExternalIcon() {
      return {
        mask: `url(${this.iconClass}) no-repeat 50% 50%`,
        '-webkit-mask': `url(${this.iconClass}) no-repeat 50% 50%`
      }
    }
  }
}
</script>

<style scoped>
.svg-icon {
  width: 1em;
  height: 1em;
  vertical-align: -0.15em;
  fill: currentColor;
  overflow: hidden;
}

.svg-external-icon {
  background-color: currentColor;
  mask-size: cover !important;
  display: inline-block;
}
</style>

③新建validate.js （utils/validate.js）

export function isExternal(path) {
  return /^(https?:|mailto:|tel:)/.test(path)
}

4.在main.js中引入

import '@/icons' // icon

5.使用

使用格式<svg-icon icon-class="文件名"/> 。这里的文件名就是在src/icons/svg下的文件名