A Font-Like SVG Icon System for Vue

Managing icons in Vue.js can be tricky. Icon fonts are convenient but lack customization flexibility, and version control can be a nightmare due to their binary nature. SVGs offer a superior solution, but maintaining ease of use and efficient management requires a thoughtful approach.

This article presents an ideal SVG icon system for Vue.js applications, focusing on simplicity and maintainability:

• Icon Addition/Removal: Simply add or delete SVGs from a designated folder.
• Usage: Use icons in templates with the straightforward syntax <svg-icon icon="rocket"></svg-icon>.
• Styling: Scale and color icons using CSS font-size and color properties, mimicking icon font behavior.
• Optimization: Avoids SVG code duplication for multiple instances of the same icon.
• Webpack Integration: No webpack configuration changes are needed.

This system is built using two small, single-file Vue components and requires:

• Webpack: Assumed if using the Vue CLI.
• svg-inline-loader: Installable via npm install svg-inline-loader --save-dev. This loader cleans up unnecessary parts of the SVG code.

The SVG Sprite Component (SvgSprite.vue)

To prevent SVG code repetition, we create an SVG sprite—a hidden SVG containing all other SVG icons. Icons are accessed via the <use></use> tag referencing the icon's ID: <svg><use xlink:href="#rocket"></use></svg>. The SvgSprite component implements this:

<template>
  <svg height="0" style="display: none;" v-html="$options.svgSprite" width="0"></svg>
</template>

<script>
const svgContext = require.context(
  '!svg-inline-loader?'  
  'removeTags=true'   // Remove title tags, etc.
  '&removeSVGTagAttrs=true'   // Remove attributes
  '&removingTagAttrs=fill'   // Remove fill attributes
  '!@/assets/icons', // Icon directory
  true, // Search subdirectories
  /\w \.svg$/i // Only include SVG files
);

const symbols = svgContext.keys().map(path => {
  const id = path.replace(/^\.\/(.*)\.\w $/, '$1'); // Extract ID from filename
  const content = svgContext(path); // Get SVG content
  return content.replace('<svg', `<symbol id="${id}"`).replace('svg>', 'symbol>'); // Convert to symbol
});

export default {
  name: 'SvgSprite',
  svgSprite: symbols.join('\n'), // Concatenate symbols
};
</script>

The template includes a hidden <svg></svg> element whose content is dynamically generated by $options.svgSprite. The script uses require.context with svg-inline-loader to process SVGs, removing unnecessary tags and attributes. It then converts each SVG into a <symbol></symbol> element, adding a unique ID.

Place this component at the top of your App.vue file.

The Icon Component (SvgIcon.vue)

The SvgIcon component is simpler, using the <use></use> tag to reference icons from the sprite:

<template>
  <svg class="icon" :class="{ 'icon-spin': spin }">
    <use :xlink:href="`#${icon}`"></use>
  </svg>
</template>

<script>
export default {
  name: 'SvgIcon',
  props: {
    icon: { type: String, required: true },
    spin: { type: Boolean, default: false },
  },
};
</script>

<style scoped>
svg.icon {
  fill: currentColor;
  height: 1em;
  margin-bottom: 0.125em;
  vertical-align: middle;
  width: 1em;
}
svg.icon-spin {
  animation: icon-spin 2s infinite linear;
}
@keyframes icon-spin {
  from { transform: rotate(0deg); }
  to { transform: rotate(359deg); }
}
</style>

The CSS styles the icon to behave like an icon font, enabling easy color and size adjustments. A spin prop adds animation.

Register this component in main.js:

import Vue from 'vue'
import SvgIcon from '@/components/SvgIcon.vue'
Vue.component('svg-icon', SvgIcon)

This system provides a clean, efficient, and easily maintainable solution for managing SVG icons in your Vue.js applications. Further improvements could include handling non-square aspect ratios and broader framework/build tool compatibility.

The above is the detailed content of A Font-Like SVG Icon System for Vue. For more information, please follow other related articles on the PHP Chinese website!