/vite-plugin-vue-svg-icons

可改变svg color、size 的组件, 支持全部iconfont.cn 上的svg

Primary LanguageJavaScript

vite-plugin-vue-svg-icons

English | 简体中文|v3.0.0 README.3.0.md

介绍

一个svg图标的插件,无需每个svg都发起http请求, 组件可以改变color、size, 支持全部iconfont.cn上的svg

版本

2022-5-28,新增v3.0.0开始采用svg use进行复制显示,不再直接显示svg源码,
详情请看 README.3.0.md 文档

v1.1.7和以下版本 是直接显示svg的

v3.0.0 README.3.0.md

安装

yarn add vite-plugin-vue-svg-icons@1.1.6 -D

npm i vite-plugin-vue-svg-icons@1.1.6 -D

pnpm add vite-plugin-vue-svg-icons@1.1.6 -D

vite.config.js 使用说明

    import vitePluginVueSvgIcons from 'vite-plugin-vue-svg-icons'
    export default defineConfig({
        plugins: [
            vitePluginVueSvgIcons(Object)
        ],
    })

vitePluginVueSvgIcons 方法传参,Object, 如果不需要的svg图标建议不要放在目录下

参数名 类型 描述 默认值
dir String 存放svg图标的目录 ${process.cwd()}/src/assets/svg

svg组件使用说明

    // app.vue 局部注册使用
    <script setup>
        import svgIcon from 'svg-icon'
    </script>
    // name参数是写定义的文件名称,比如:svg/logo.svg,那么你引用这个svg 只需要name="logo"
    <template>
        <svgIcon name="logo" color="#f00" size="80" />
    </template>
    // main.js 全部注册
    import svgIcon from 'svg-icon'
    VueApp.component('svg-icon', svgIcon);

组件参数说明

参数名 类型 默认值
name String -
color String svg自带值, 不设置就不会更改svg原本的color
size Number 默认15px, 设置为false, 无默认值,svg也不会被设置上大小
class String -