跳转到内容

unIcons

NPM Version

WinJS 提供的有关 icons 统一解决方案,以 unplugin-icons 作为底层解析工具。适配多种构建工具,如 webpack, rspack, vite 等和前端框架,如 vue2,vue等。插件本身也内置了 Resolver 功能,可自动引入所需的 svg 图标。

注意

请先掌握 unplugin-icons 的用法。

开启方式

  1. 安装插件
bash
$ npm add @winner-fed/plugin-unicons -D
bash
$ yarn add @winner-fed/plugin-unicons -D
bash
$ pnpm add @winner-fed/plugin-unicons -D
bash
$ bun add @winner-fed/plugin-unicons -D
  1. 在配置文件中 .winrc 中开启该功能
ts
import { defineConfig } from 'win';

export default defineConfig({
  plugins: [require.resolve('@winner-fed/plugin-unicons')],
  unIcons: {
    include: [],
    // 支持 unplugin-icons 配置参数,如
    customCollections: {
      ...
    }
    
  }
});

配置

include

  • 类型Array<string>
  • 默认值[]

用于额外需要使用此方案解析的 svg 文件。注意需要使用绝对路径,并且会被插件内置的 svgo 压缩。

支持 unplugin-icons 扩展配置

注意

  • 在使用本地图标时,根据unplugin-icons的命名规则,默认使用 icon 作为前缀(prefix),win 作为集合(collection)。默认解析 src/icons 下的 svg 图标,如 icon-win-dog

基于 MIT 许可发布