npmpackage.info

Gathering detailed insights and metrics for @aidol/svg-icon

Other packages similar to @aidol/svg-icon

vue-symbol-icon

3.0.2

A Vue SVG Symbol icon component for svg-sprite-loader, Easy to custom SVG icon 's color and size!!!

@aidol/svg-icon

A Vue SVG Symbol icon component for svg-sprite-loader, Easy to custom SVG icon 's color and size!!!

2.1.4

MIT

Vue

3.14 kB

4,819 1.7

Installations

npm install @aidol/svg-icon

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.21.1

NPM Version

6.14.17 Score

Supply Chain

Quality

75.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

25

Closed

24

Issues

Open

0

Total

0

Closed

0

Releases

v2.1.1

Published on 28 Feb 2023

View all 1 releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

Vue

JavaScript

HTML

Vue (58.03%)

JavaScript (30.75%)

HTML (11.23%)

Developer

yisibell

Download Statistics

Total Downloads

4,819

Last Day

Last Week

Last Month

Last Year

496

GitHub Statistics

1 Stars

31 Commits

2 Watching

2 Branches

1 Contributors

Bundle Size

7.47 kB

Minified

3.14 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.1.4

Package Id

@aidol/svg-icon@2.1.4

Unpacked Size

66.61 kB

Size

13.22 kB

File Count

NPM Version

6.14.17

Node Version

14.21.1

Publised On

01 Mar 2023

Total Downloads

Cumulative downloads

Total Downloads

4,819

Last day

400%

Compared to previous day

Last week

42.9%

Compared to previous week

Last month

18.4%

Compared to previous month

Last year

-68.6%

496

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

vue

Dev Dependencies

@babel/core @babel/eslint-parser @vue/cli-plugin-babel @vue/cli-plugin-eslint @vue/cli-service @vue/eslint-config-standard changelogen core-js cz-conventional-changelog eslint eslint-plugin-import eslint-plugin-n eslint-plugin-prettier eslint-plugin-promise eslint-plugin-vue svg-sprite-loader vue

Versions

WARNING: This Package is no longer maintained, Please use vue-symbol-icon instead.

@aidol/svg-icon

A Vue SVG Symbol icon component for svg-sprite-loader, Easy to custom SVG icon 's color and size!!!

TIPS: @aidol/svg-icon needs to be used in conjunction with svg-sprite-loader . So, please pre-install svg-sprite-loader and config it.

Features

Ability to manipulate SVG icons. e.g. using font-size and color.
Support Iconfont svg icons.

Installation

1# pnpm
2$ pnpm add @aidol/svg-icon
3
4# yarn
5$ yarn add @aidol/svg-icon
6
7# npm
8$ npm i @aidol/svg-icon

Usage

demo.vue

1<template>
2  <svg-icon icon-class="svg-symbol-id" font-size="36px" color="red" />
3</template>

Properties

Prop name	Default value	Required	Description	Type
`icon-class`	`undefined`	`true`	SVG Symbol Id which is SVG filename in the SVG folder.	`string`
`className`	`undefined`	`false`	Add Extra class name to SVG Element	`string`
`color`	`undefined`	`false`	Define SVG color	`string`
`fontSize`	`undefined`	`false`	Define SVG size	`string`

How to config svg-sprite-loader ?

In `Vue CLI`

First, you need config webpack with chainWebpack:

1// vue.config.js
2const path = require('path')
3
4function resolve(dir) {
5  return path.join(__dirname, dir)
6}
7
8module.exports = {
9  // ...
10  chainWebpack(config) {
11    
12    // Change the configuration of url-loader so that it does not process svg files used as icons in the specified folder
13    config.module
14      .rule("svg")
15      .exclude.add(resolve("src/icons"))
16      .end();
17
18    // Add svg-sprite-loader to process svg files in the specified folder
19    config.module
20      .rule("icons")
21      .test(/\.svg$/)
22      .include.add(resolve("src/icons"))
23      .end()
24      .use("svg-sprite-loader")
25      .loader("svg-sprite-loader")
26      .options({
27        symbolId: "icon-[name]"
28      })
29      .end();
30  }
31}

Then, place your .svg icon files in the src/icons/svg folder.
Defines the entry point for batch importing .svg modules:

1// src/icons/index.js
2
3import Vue from 'vue'
4import SvgIcon from '@aidol/svg-icon' // svg component
5
6// 1. register globally
7Vue.component('svg-icon', SvgIcon) 
8
9// 2. require svg files
10const req = require.context('./svg', false, /\.svg$/)
11const requireAll = requireContext => requireContext.keys().forEach(requireContext)
12requireAll(req)

Finally, these .svg files are centrally imported in the project entry file main.js.

1import Vue from 'vue'
2
3import '@/icons'
4
5new Vue({
6  // ...
7})

In Nuxt2

First, config webpack in the nuxt.config.js:

1// nuxt.config.js
2
3export default {
4  // ...
5  // Build Configuration (https://go.nuxtjs.dev/config-build)
6  build: {
7    /*
8     ** You can extend webpack config here
9     */
10    extend(config, { isClient }) {
11      if (isClient) {
12        const svgRule = config.module.rules.find((rule) =>
13          rule.test.test('.svg')
14        )
15        svgRule.exclude = [resolve('assets/icons/svg')]
16
17        // Includes /assets/icons/svg for svg-sprite-loader
18        config.module.rules.push({
19          test: /\.svg$/,
20          include: [resolve('assets/icons/svg')],
21          loader: 'svg-sprite-loader',
22          options: {
23            symbolId: 'icon-[name]',
24          },
25        })
26      }
27    },
28  }
29  // ...
30}

Centralize your *.svg icon files in the ~/assets/icons/svg folder.
Create a new ~/plugins/svg-icon.js file and write in it:

1import Vue from 'vue'
2import SvgIcon from '@aidol/svg-icon' // svg component
3
4// 1. register globally
5Vue.component('svg-icon', SvgIcon) 
6
7// 2. require svg files
8const req = require.context('~/assets/icons/svg', false, /\.svg$/)
9const requireAll = (requireContext) => requireContext.keys().forEach(requireContext)
10requireAll(req)

Configure the svg-icon plugin to nuxt.config.js:

1export default {
2  // ...
3
4  plugins: [
5    // ...
6    { src: '~/plugins/svg-icon', mode: 'client' }
7  ]
8
9  // ...
10}

CHANGE LOG

CHANGE LOG.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @aidol/svg-icon

@aidol/svg-icon

Installations

Developer Guide

No

CommonJS

14.21.1

6.14.17

Score

Pull Requests

1

25

24

Issues

0

0

0

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

yisibell

Download Statistics

GitHub Statistics

Bundle Size

7.47 kB

3.14 kB

Maintainers

Package Meta Information

Total Downloads

4,819

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

@aidol/svg-icon

Features

Installation

Usage

Properties

How to config svg-sprite-loader ?

In Vue CLI

In Nuxt2

CHANGE LOG

10

10

0

0

0

0

0

0

0

0

1.7

/10

In `Vue CLI`