美文网首页
vue封装使用 svg-icon组件

vue封装使用 svg-icon组件

作者: 扶得一人醉如苏沐晨 | 来源:发表于2023-08-18 10:57 被阅读0次

    一、SVG(Scalable Vector Graphics)可缩放矢量图形

    SVG(Scalable Vector Graphics)可缩放矢量图形,是一种用于描述基于二维的矢量图形的 XML 标记语言,其基本矢量显示对象包括矩形、圆、椭圆、多边形、直线、任意曲线等,还能显示文字对象和嵌入式外部图像(包括 PNG、JPEG、SVG 等)。实际项目中大多数图标都是使用的 SVG 图标文件,其主要有以下几个优点:

    • 内容可读,文件是纯粹的 XML。

    • 图像文件小,可伸缩性强。

    • 矢量放缩,能以不牺牲图像质量为前提,进行任意缩放。

    • 还能基于 DOM 模型实现动态和一些交互功能

    二、SVG在vue项目中的配置与使用

    2.1、src--assets--icons--svg(存放你的svg图标)

    image.png

    2.2、src--assets--icons--index.js

    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)
    

    2.3、src--assets--icons--svgo.yml(暂未用到)

    # replace default config
    
    # multipass: true
    # full: true
    
    plugins:
    
      # - name
      #
      # or:
      # - name: false
      # - name: true
      #
      # or:
      # - name:
      #     param1: 1
      #     param2: 2
    
    - removeAttrs:
        attrs:
          - 'fill'
          - 'fill-rule'
    

    三、SvgIcon组件封装

    image.png

    3.1、index.vue

    用于定义可由<use>元素实例化的图形模板对象
    <use> 元素从 SVG 文档中获取节点,并在其他地方复制它们。

    <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>
    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;
      fill: currentColor;
      overflow: hidden;
      font-size: 16px;
    }
    
    .svg-external-icon {
      background-color: currentColor;
      mask-size: cover !important;
      display: inline-block;
    }
    </style>
    

    四、main.js引入

    import "./assets/icons"; // icon
    

    五、安装插件svg-sprite-loader

    npm install svg-sprite-loader --save
    

    六、vue.config.js添加插件的配置项

    const path = require("path");
    
    function resolve(dir) {
      return path.join(__dirname, dir);
    }
    module.exports = defineConfig({
      chainWebpack(config) {
        config.plugins.delete("preload"); // TODO: need test
        config.plugins.delete("prefetch"); // TODO: need test
    
        // set svg-sprite-loader
        config.module.rule("svg").exclude.add(resolve("src/assets/icons")).end();
        config.module
          .rule("icons")
          .test(/\.svg$/)
          .include.add(resolve("src/assets/icons"))
          .end()
          .use("svg-sprite-loader")
          .loader("svg-sprite-loader")
          .options({
            symbolId: "icon-[name]",
          })
          .end();
      },
    });
    

    七、使用

    setting就是你下载的矢量图的文件名

    <svg-icon icon-class="setting" />
    

    相关文章

      网友评论

          本文标题:vue封装使用 svg-icon组件

          本文链接:https://www.haomeiwen.com/subject/ffqdmdtx.html