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-iconfont

v1.4.2

Published

This plugin is for auto download iconfont symbol js file

Downloads

248

Readme

⚡vite-plugin-iconfont

npm npm

这是一个自动下载iconfont symbol js到项目的vite 插件,支持以下特性:

  • 自动下载iconfont symbol js 到本地,构建时进行Tree-Shaking优化。
  • 自动生成iconfont json配置。
  • 自动生成iconfont TypeScript类型声明文件。
  • 支持构建时自动注入index.html。
  • 支持生成iconify文件,配合Iconify IntelliSense可实现图标预览和自动补全。
  • 多图标库支持,自定义图标打包。

安装

npm install -D vite-plugin-iconfont
// 或
yarn add -D vite-plugin-iconfont
// 或
pnpm install -D vite-plugin-iconfont

基本使用方法

添加插件到vite.config.js

  • 单图标库
import { defineConfig } from 'vite';
import Iconfont from 'vite-plugin-iconfont';
export default defineConfig({
  plugins: [
    Iconfont({
      url: 'iconfont symbol js url'
    })
  ]
});
  • 多图标库
import { defineConfig } from 'vite';
import Iconfont from 'vite-plugin-iconfont';
export default defineConfig({
  plugins: [
    Iconfont([{
      url: 'iconfont symbol js url1'
    },
    {
      url: 'iconfont symbol js url2'
    },
    //...another options
    ])
  ]
});

配置选项(options)

类型说明

Iconfont(opt: Option | Option[]) => Promise<Plugin>;
interface Option {
    /**
     * iconfont symbol js url
     */
    url: string;
    /**
     * 保存自动下载iconfont symbol js的路径
     */
    distUrl?: string;
    /**
     * iconfont symbol js是否自动注入到index.html
     */
    inject?: boolean;
    /**
     * 是否生成icon类型声明文件,可以为boolean或者具体生成的路径
     */
    dts?: boolean | string;
    /**
     * 自动生成iconfont图标集合
     */
    iconJson?: boolean | string;
    /**
     * 图标前缀, 默认icon
     */
    prefix?: string;
    /**
     * 图标前缀中的分隔符,默认为-
     */
    prefixDelimiter?: string;
    /**
     * iconifyjson文件生成的路径
     */
    iconifyFile?: boolean | string;
    /**
     * 是否进行摇树优化
     */
    jsShaking?: boolean;
    /**
     * 指定图标集合进行打包
     */
    pickIconList?: string[];
}

详细说明

url

iconfont使用symbol引用方式,生成的项目js地址,该参数为主要输入参数。

  • Type : string
  • Default : ''
  • Required :true

distUrl

保存iconfont到项目的js地址。

  • Type : string
  • Default : iconfont.js
  • Required :false

iconJson

生成iconfont json配置路径,默认文件名称:iconfont.json

  • Type : boolean|string
  • Default : false
  • Required :false

inject

iconfont symbol js是否自动注入到index.html文件。

inject:false时,不进行图标Tree-Shaking优化,并须配置distUrl和手动将文件路径注入到index.html文件中。

inject:true时,构建时将进行图标Tree-Shaking优化,distUrl将受vite的basebuild.assetsDir配置影响,并自动注入到index.html文件。

最佳实践建议:当inject:true时,可不配置distUrl参数,采用插件内置规则自动注入。

  • Type : boolean
  • Default : true
  • Required :false

dts

生成TypeScript 类型声明文件,false不生成,也可以是具体生成类型声明文件的文件路径地址,默认文件名称:iconfont.d.ts

  • Type : boolean|string
  • Default : false
  • Required :false

注意:要获得eslint的支持请在eslint配置文件中增加如下配置:

{
  globals: {
    Iconfont: true,
  },
  ...
}

prefix

图标前缀,iconfont默认为icon

注意:和iconfont设置的前缀不一样,如果iconfnt上设置的前缀为icon-,则需要设置prefix为icon,prefixDelimiter为-。即:iconfont前缀 = prefix + prefixDelimiter

  • Type : string
  • Default : icon
  • Required :false

prefixDelimiter

图标前缀中的分隔符,默认为-

  • Type : string
  • Default : -
  • Required :false

iconifyFile

iconifyjson文件生成的路径,不设置则不生成。

  • Type : string
  • Default : ``
  • Required :false

jsShaking

开启图标库的tree-Shaking优化,inject:true时有效。

  • Type : boolean
  • Default : true
  • Required :false

pickIconList

需要提取的图标列表,不设置则提取所有图标。

  • Type : string[]
  • Default : []
  • Required :false

示例

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import Iconfont from 'vite-plugin-iconfont';
// https://vitejs.dev/config/
export default () => {
  return defineConfig({
    plugins: [
      vue(),
      Iconfont({
        url: 'iconfont symbol js url',
        distUrl: './public/assets/fonts/iconfont.js',
        iconJson: './public/iconfont.json',
        dts: './types/iconfont.d.ts',
        inject:false
      }),
    ]
  });
};

使用iconify

如果使用Iconify IntelliSense,可以不生成dts,也可使用自动补全,还可以实时预览,使用方法如下:

  1. 设置对应参数,如:
  Iconfont({
    url: 'iconfont symbol js url', // 替换成你自己的iconfont项目地址
    distUrl: './public/iconfont/iconfont.js',
    prefix: 'icon-', // 默认为icon-,可不设置
    iconifyFile: './.iconify.json' // 关键是设置这个
  }),
  1. 安装vscode插件Iconify IntelliSense

  2. 在项目vscode配置.vscode/settings.json中增加配置。

{
  "iconify.customCollectionJsonPaths": ["./.iconify.json"]
}
  1. 重启或者重载一下编辑器窗口(cmd+shift+p,然后Reload window)即可成功预览图标,效果如下。 预览 自动补全