vue中使用本地svg,抽为全局组件svg-icon

本文详细介绍如何在Vue项目中创建并使用全局SVG图标组件,包括设置图标文件夹、配置Webpack、注册组件及在项目中调用的方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

vue中使用本地svg,抽为全局组件svg-icon

今天增加一个svg全局组件,却怎么都显示不出来,在这里记录下全过程。

增加icon文件夹

在这里插入图片描述
vue项目中src目录下增加icons文件夹,文件夹中放置页面需要用到的svg,及入口文件index.js
index.js中内容如下:

	import Vue from 'vue'
	import SvgIcon from '@/components/SvgIcon'// 引入svg组件

	// 注册全局组件
	Vue.component('svg-icon', SvgIcon)
	// require.context,通过正则匹配到可能的文件,全部引入
	const req = require.context('./svg', false, /\.svg$/)
	const requireAll = requireContext => requireContext.keys().map(requireContext)
	requireAll(req)

SvgIcon组件

在components文件夹下增加SvgIcon文件夹,文件夹中增加index.vue,这里主要定义组件。

<template>
<svg :class="svgClass" aria-hidden="true">
    <use :xlink:href="iconName"/>
</svg>
</template>
<script>
export default {
name: 'SvgIcon',
props: {
    iconClass: {
    type: String,
    required: true
    },
    className: {
    type: String,
    default: ''
    }
},
computed: {
    iconName() {
    return `#icon-${this.iconClass}`
    },
    svgClass() {
    if (this.className) {
        return 'svg-icon ' + this.className
    } else {
        return 'svg-icon'
    }
    }
  }
}
</script>

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

xlink:href 中传入 svg ID 就好了,由于在上面的配置文件中我们直接使用文件名作为 symbol 的 ID,所以这里传入的 ID 即为你想显示的图标的 svg 文件名

main.js中导入icons

import './icons' // icon 引入icons文件夹下所有的icon

修改配置

修改webpack.base.conf.js

 {
    test: /\.svg$/,
    loader: 'svg-sprite-loader',
    include: [resolve('src/icons')],
    options: {
      symbolId: 'icon-[name]'
    }
  },
  {
    test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
    loader: 'url-loader',
    exclude: [resolve('src/icons')],
    options: {
      limit: 10000,
      name: utils.assetsPath('img/[name].[hash:7].[ext]')
    }
  },

webpack添加处理svg的loader,第一个用来处理svg的,第二个是去除svg处理的。
到这里就可以直接在代码中直接使用 <svg-icon icon-class="shopping" class-name="样式名"/> 来引入一个svg图片,只需要修改icon-class为当前svg的名称即可。
这里需要注意的是,这里配置修改了需要重启,不然可能不生效

### 创建和使用自定义 SVG 图标组件 #### 配置 Vite 构建工具 为了简化开发流程并提高性能,在 `vite.config.js` 中配置插件来处理 SVG 文件: ```javascript import { resolve } from 'path'; import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'; export default defineConfig({ plugins: [ vue(), createSvgIconsPlugin({ iconDirs: [resolve(process.cwd(), 'public/icons')], // 存放SVG文件的位置 symbolId: 'icon-[dir]-[name]' // 定义symbol ID格式 }), ], }); ``` 此设置允许开发者通过简单的标签调用任何已注册的图标[^2]。 #### 编写全局 SVG 组件 创建名为 `SvgIcon.vue` 的单文件组件用于渲染动态传入名称对应的 SVG 路径数据: ```vue <template> <svg :class="className"> <use :xlink:href="`#${props.icon}`"></use> </svg> </template> <script setup lang="ts"> interface Props { icon?: string; className?: string; } const props = withDefaults(defineProps<Props>(), { icon: '', className: '' }) </script> ``` 上述代码片段展示了如何构建一个可重用且灵活的 SVG 显示容器,它接受两个属性参数——图标的唯一标识符以及额外样式类名[^1]。 #### 注册为全局组件 为了让整个应用程序都能方便地访问到这个新组建而无需每次都单独导入, 可以将其作为全局组件安装在应用入口处(main.ts 或 main.js): ```typescript // 导入 SvgIcon 组件 import SvgIcon from './components/SvgIcon.vue' app.component('SvgIcon', SvgIcon); ``` 这样做的好处是可以直接在模板里像 HTML 标签一样书写 `<SvgIcon>` 使用该组件。 #### 实际应用场景中的运用 当页面需要展示某个特定图标时只需简单声明即可实现预期效果: ```html <!-- 展示 home.svg --> <SvgIcon icon="icon-home" class="custom-class"/> ``` 这里的 `icon-home` 是由前面提到过的 `symbolId` 规则决定的具体实例化后的ID值;而附加的 CSS 类可用于进一步定制外观表现形式。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值