unIcons

A unified icon solution provided by WinJS, using unplugin-icons as the underlying parsing tool. Compatible with multiple build tools such as webpack, rspack, vite, etc., and frontend frameworks such as Vue 2, Vue, etc. The plugin also has built-in Resolver functionality that can automatically import required SVG icons.

Note

Please master the usage of unplugin-icons first.

Setup

1. Install the plugin

NPM

$ npm add @winner-fed/plugin-unicons -D

YARN

$ yarn add @winner-fed/plugin-unicons -D

PNPM

$ pnpm add @winner-fed/plugin-unicons -D

BUN

$ bun add @winner-fed/plugin-unicons -D

2. Enable the plugin in the .winrc configuration file

import { defineConfig } from 'win';

export default defineConfig({
  plugins: [require.resolve('@winner-fed/plugin-unicons')],
  unIcons: {
    include: [],
    // Supports unplugin-icons configuration parameters, such as
    customCollections: {
      ...
    }
    
  }
});

Configuration

include

• Type: Array<string>
• Default: []

Used for additional SVG files that need to be parsed using this solution. Note that absolute paths must be used, and they will be compressed by the plugin's built-in svgo.

Supports unplugin-icons Extended Configuration

• Inherits configuration parameters from the unplugin-icons plugin

Note

• When using local icons, according to the naming rules of unplugin-icons, it uses icon as the prefix by default and win as the collection. It parses SVG icons under src/icons by default, such as icon-win-dog