npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-import-icons

v1.0.1

Published

用于引入 SVG 图标的 Vite 插件,支持自动引入和热更新。

Downloads

12

Readme

vite-plugin-import-icons

用于引入 SVG 图标的 Vite 插件,支持自动引入和热更新。

安装

pnpm add vite-plugin-import-icons -D

配置

// vite.config.ts
import ImportIcons from 'vite-plugin-import-icons'

export default defineConfig({
    plugins: [
        ImportIcons({ /* options */ }),
    ],
});

collections

用于配置图标集,一个图标集对应一个存放图标的文件夹。

import path from 'path';

ImportIcons({
    collections: {
        icons: path.resolve(__dirname, './src/assets/icons'),
    },
});

transform

加载图标时自定义转换 SVG 文件,例如给图标添加 fill 属性。

ImportIcons({
    transform(svg, collection, icon) {
        // apply fill to this icon on this collection
        if (collection === 'icons' && icon === 'account') {
            return svg.replace(/^<svg /, '<svg fill="currentColor" ');
        }
        return svg;
    },
});

使用

~icons/{collection}/{icon} 的格式引入需要的图标,collection 表示图标集,icon 表示图标名。

<template>
    <icons-home></icons-home>
    <icons-setting></icons-setting>
</template>

<script setup lang="ts">
import IconsHome from '~icons/icons/home';
import IconsSetting from '~icons/icons/setting';
</script>
// vite.config.ts
import path from 'path';
import ImportIcons from 'vite-plugin-import-icons';

export default {
    plugins: [
        ImportIcons({
            collection: {
                icons: path.resolve(__dirname, './src/assets/icons'),
            }
        })
    ],
};

自动引入

配合 unplugin-vue-components/vite 插件可以实现自动引入。

<template>
    <icons-home></icons-home>
    <other-icons-bar></other-icons-bar>
</template>
// vite.config.ts
import path from 'path';
import ImportIcons, { ImportIconsResolver } from 'vite-plugin-import-icons';
import Components from 'unplugin-vue-components/vite';

export default {
    plugins: [
        Components({
            resolvers: [
                ImportIconsResolver(),
            ],
        }),
        ImportIcons({
            collection: {
                icons: path.resolve(__dirname, './src/assets/icons'),
                'other-icons': path.resolve(__dirname, './src/assets/other-icons'),
            }
        })
    ]
}

批量引入

可以通过 import.meta.icons 函数一次性引入多个图标,函数的第一个参数为图标集,第二个参数为 glob 字符串,函数返回值是一个以 key 为图标名,value 为对应图标组件的对象。

<template>
    <component v-for="(icon, name) in icons" :is="icon" :key="name"></component>
</template>
<script>
const icons = import.meta.icons('icons', 'menu-*')
</script>
// vite.config.ts
import path from 'path';
import ImportIcons, { ImportIconsResolver } from 'vite-plugin-import-icons';
import Components from 'unplugin-vue-components/vite';

export default {
    plugins: [
        ImportIcons({
            collection: {
                icons: path.resolve(__dirname, './src/assets/icons'),
            }
        })
    ],
};