nuxt-symbol-icons

A nuxt(2) module for using svg sprite icon.
3,156 1
svg icon nuxt-module svg-sprite-loader nuxt2 vue-symbol-icon
Install
npm install nuxt-symbol-icons
Latest Version:2.1.2
Vue:2
License:MIT
Last Updated:Apr 23, 2023
Links: GitHub  ·  npm
Maintainer: elenh


nuxt-symbol-icons

A nuxt(2) module for using svg sprite icon.

Features

Installation

# yarn
$ yarn add --dev nuxt-symbol-icons

# npm 
$ npm i nuxt-symbol-icons -D

# pnpm
$ pnpm add --dev nuxt-symbol-icons

Usage

  1. Configure your nuxt.config.js
// nuxt.config.js

module.exports = {
  // ...
  buildModules: ['nuxt-symbol-icons'],
  nuxtSymbolIcons: {
    // ...
  }
}

  1. Put your SVG icon into ~/assets/icons/svg/ folder.

  2. then, you can use <svg-icon name="icon-name" /> in projects. The <svg-icon /> component powered by vue-symbol-icon

Options

Key Type Default value Description
enable boolean true Whether to enable nuxt-symbol-icons
svgoConfig
Added in v2.0.0		 boolean/SvgoConfig {} Define configuration of SVGO, if set to false, will disable SVGO.
enableSvgoPresetDefaultConfig
Added in v2.0.0		 boolean true Whether to add preset-default config for SVGO
svgSymbolIdPrefix string icon- Define the SVG symbol id prefix.
globalComponentName string SvgIcon Define the global component name of vue-symbol-icon.
svgSpriteLoaderIncludeDir string assets/icons/svg Define the include folder for svg-sprite-loader.
requireContextSvgDir string ~/assets/icons/svg Define the SVG icons folder for Batch imports via require.context.
extraSvgSpriteLoaderOptions Record<string, any> {} Configure extra options for svg-sprite-loader.
extraPreLoaders RuleSetUseItem[] [] Use some other loaders before svg-sprite-loader processes SVG.

CHANGE LOG

see CHANGE LOG

Related Packages

nuxt-svg-icon-module

Nuxt module for lazy-loading inline SVG icons from your assets directory

1,456 5
icon nuxt-module svg nuxt vue
@jt-icons/icon-vue-components

Vue components of JT Icons collection.

2,961 1
icon svg
vicons

SVG Vue components integrated from `fluentui-system-icons` and `ionicons`.

53,979
icon svg vue
vue-svg-icon

a simple solution for multicolor svg icon in vue

13,095
icon svg vue.js
@dangojs/digitforce-icons-vue

Vue3 Icons

10,594
icon svg vue

Version History

Version Released Vue License
2.1.2 ^2.0 MIT
2.1.1 ^2.0 MIT
2.1.0 ^2.0 MIT
2.0.3 ^2.0 MIT
2.0.2 ^2.0 MIT