waltz-icons v0.0.19

Waltz Icons

On-demand inline SVG icons!

Introduction

Waltz Icons is a Vite/Webpack plugin that makes it possible to serve icons statically on demand. It searches for icons names in modules source code and compiles them into a single SVG file during the build time. All design credits goes to Iconscout.

Advantages

• It doesn't reflect on JavaScript bundle size
• A big project with a lot of icons will generate a SVG file as small as some few kilobytes

Usage

Configuration

export type Options = {
  /**
   * HTML tag to be searched for.
   */
  tag?: string
  /**
   * Ensure certain icons are always collected.
   * Useful when icons can't be found with static search.
   */
  ensureList?: Array<string>
  /**
   * Will scrap DOM files in the specified libraries case set.
   * (in webpack you must use a custom module.rules property to emulate this prop).
   */
  libraries?: Array<string>
  /**
   * Lets user execute custom logic before emitting output.
   * A common use case is to search for icons outside conventional files.
   * (currently unsupported in Webpack).
   */
  preEmit?: () => Promise<void>
  /**
   * Case set to true, compiles all collected icons to a single SVG.
   * Otherwise will output each icon in a separated SVG file.
   * (currently unsupported in Webpack).
   * @default true
   */
  pack?: boolean
  /**
   * Case set to true will append a timestamp to icons filename to invalidate cache.
   * Useful when you have cache policies configured in your webserver.
   * @default false
   */
  hash?: boolean
}

Vite

import defineConfig from 'vite'
import waltzIcons from 'waltz-icons/vite'

export default defineConfig({
  plugins: [
    waltzIcons({
      // ...
    })
  ]
})

Webpack

First you need to make some additions in your webpack config file:

const webpackConfig = {
  resolveLoader: {
    alias: {
      // make sure you have this alias set
      'icon-loader': 'waltz-icons/webpack-loader'
    }
  },
  module: {
    // then set up the loader after vue/babel/whatever else loader
    // (the order matters)
    rules: [
      {
        test: /(\.vue|router\.(t|j)s)$/,
        loader: 'icon-loader',
        options: {
          // ...
        }
      },
    ]
  },
  plugins: [
    // not required
    // use this to emit a preload script
    new require('waltz-icons/webpack').Plugin()
  ]
}

Component setup

Next, all you have to do is create your icon component according to your application needs. We gonna be using Vue in this example but it really doesn't matter, you could be using React or anything else, including pure HTML5.

!IMPORTANT The property that specifies the icon name MUST BE named "icon" for the pattern matching to work.

<script setup>
withDefaults(
  defineProps({
    variant: String,
    icon: String
  }), {
    variant: 'line'
  }
)
</script>

<template>
  <svg
    width="24"
    height="24"
    viewBox="0 0 24 24"
  >
    <use :href="`/assets/icons.svg#${variant}:${name}`"></use>
  </svg>
</template>

Preloading

In case of options.pack is set to false (or by default when using Webpack) the plugin preloading script that you can include in your root HTML to ensure a smoother user experience.

<script type="text/javascript" src="/preload-icons.js"></script>

Available icons

Please head to https://sonata-api.github.io/waltz-icons/.

Credits

This project was inspired by Vue Unicons. The icons itself were designed by Iconscout.