oh-vue-icons - npm Package Compare versions

Comparing version 0.1.11 to 0.2.1

CHANGELOG.md

 # Change Log
 
+## [0.1.11](https://github.com/Renovamen/oh-vue-icons/compare/v0.1.10...v0.1.11) (2021-02-27)
+
+### Bug Fixes
+
+- remove `core-js` from dependencies ([#3](https://github.com/Renovamen/oh-vue-icons/issues/3)) ([53f8b69](https://github.com/Renovamen/oh-vue-icons/commit/53f8b69c4213f27128664eba64be66bd98c3daba))
+
+
 ## [0.1.10](https://github.com/Renovamen/oh-vue-icons/compare/v0.1.9...v0.1.10) (2021-02-25)
@@ -86,3 +93,3 @@
 
-# [0.1.0](https://github.com/Renovamen/oh-vue-icons/compare/19c8c9d74ebf5a23c5dc34aace3b2807b06c9a9a...v0.1.0) (2020-12-04)
+## [0.1.0](https://github.com/Renovamen/oh-vue-icons/compare/19c8c9d74ebf5a23c5dc34aace3b2807b06c9a9a...v0.1.0) (2020-12-04)
 
@@ -89,0 +96,0 @@ ### Features

CONTRIBUTING.md

@@ -39,8 +39,18 @@ # Contribution Guides
 
-To run demo:
+### Vue 2
 
 ```bash
-yarn demo
+cd demo/v2
+yarn install
+yarn dev
 ```
 
+### Vue 3
+
+```bash
+cd demo/v3
+yarn install
+yarn dev
+```
+
  
@@ -47,0 +57,0 @@

package.json

 {
   "name": "oh-vue-icons",
-  "version": "0.1.11",
+  "version": "0.2.1",
   "description": "Include inline SVG icons from different popular icon packs in Vue easily.",
@@ -38,3 +38,2 @@ "keywords": [
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "demo": "vue-cli-service serve demo/main.js",
     "dev": "nuxt",
@@ -65,16 +64,15 @@ "docs:build": "nuxt generate",
   "devDependencies": {
-    "@nuxt/content": "^1.11.1",
-    "@nuxtjs/tailwindcss": "^3.1.0",
-    "@vue/cli-service": "^4.5.11",
-    "babel-eslint": "^10.1.0",
-    "cross-env": "^5.2.1",
-    "eslint": "^7.19.0",
-    "eslint-plugin-vue": "^7.5.0",
-    "glob-promise": "^3.4.0",
+    "@nuxt/content": "^1.13.1",
+    "@nuxtjs/tailwindcss": "^3.4.2",
+    "eslint": "^7.20.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-vue": "^7.6.0",
+    "glob-promise": "^4.0.1",
     "husky": "^4.3.8",
-    "lint-staged": "^10.5.3",
-    "nuxt": "^2.14.6",
+    "lint-staged": "^10.5.4",
+    "nuxt": "^2.15.2",
     "nuxt-i18n": "^6.20.3",
-    "rimraf": "^2.7.1",
-    "sort-package-json": "^1.48.1",
+    "rimraf": "^3.0.2",
+    "sort-package-json": "^1.49.0",
     "svgo": "^1.3.2",
@@ -81,0 +79,0 @@ "vue-slider-component": "^3.2.11",

README-CN.md

@@ -7,4 +7,18 @@ # Oh, Vue Icons!
 
-`oh-vue-icons` 是一个能让你在 [Vue](https://vuejs.org/) 中轻松从多个流行图标库中引入 SVG 图标的组件。它是 tree-shakable 的，因此你能够仅引入你需要的图标从而减小打包体积。
+`oh-vue-icons` 是一个能让你在 [Vue](https://vuejs.org/) 中轻松从多个流行图标库中引入 SVG 图标的组件。
 
+
+ 
+
+## 特性
+
+- 它是 tree-shakable 的，因此你能够仅引入你需要的图标从而减小打包体积
+- 支持 Vue 2 和 Vue 3
+- 支持 [15 个流行的图标库](#支持的图标库)
+
+
+ 
+
+## 支持的图标库
+
 目前支持以下 15 个图标库：
@@ -24,5 +38,5 @@
 | [Pokemon Icons](https://theartificial.github.io/pokemon-icons/) (Colorful)| `pi`   | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) | 1453      |
-| [Pixel Icons](https://pixelarticons.com/)                     | `px`   | [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) | 451       |
+| [Pixelarticons](https://pixelarticons.com/)                   | `px`   | [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) | 460       |
 | [Remix Icon](https://github.com/Remix-Design/RemixIcon)       | `ri`   | [Apache 2.0](https://github.com/Remix-Design/RemixIcon/blob/master/License) | 2271       |
-| [Simple Icons](https://simpleicons.org/)                      | `si`   | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1799       |
+| [Simple Icons](https://simpleicons.org/)                      | `si`   | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1831       |
 | [VSCode Icons](https://github.com/vscode-icons/vscode-icons) (Colorful) | `vi`   | [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) | 1061       |
@@ -49,2 +63,3 @@ | [Weather Icons](https://erikflowers.github.io/weather-icons/) | `wi`   | [SIL OFL 1.1](http://scripts.sil.org/OFL)                     | 219        |
 
+
  
@@ -56,18 +71,20 @@
 
-首先需要在 `main.js` 中引入 `oh-vue-icons`。你可以只引入你需要的图标从而减小打包体积，比如：
+首先需要在 `main.js` 中引入 `oh-vue-icons`。你可以只引入你需要的图标从而减小打包体积。
 
+#### Vue 2
+
 ```js
 // main.js
-import Vue from 'vue'
-import App from './App.vue'
-import OhVueIcon from 'oh-vue-icons/components/Icon'
+import Vue from "vue";
+import App from "./App.vue";
+import OhVueIcon from "oh-vue-icons/components/icon";
 
-import { FaFlag, RiZhihuFill } from 'oh-vue-icons/icons'
-OhVueIcon.add([FaFlag, RiZhihuFill])
+import { FaFlag, RiZhihuFill } from "oh-vue-icons/icons";
+OhVueIcon.add([FaFlag, RiZhihuFill]);
 
-Vue.component('v-icon', OhVueIcon)
+Vue.component("v-icon", OhVueIcon);
 
 new Vue({
   render: h => h(App)
-}).$mount('#app')
+}).$mount("#app");
 ```
@@ -86,2 +103,18 @@
 
+#### Vue 3
+
+```js
+// main.js
+import { createApp } from "vue";
+import App from "./App.vue";
+import OhVueIcon from "oh-vue-icons/components/icon-v3";
+
+import { FaFlag, RiZhihuFill } from "oh-vue-icons/icons";
+OhVueIcon.add([FaFlag, RiZhihuFill]);
+
+const app = createApp(App);
+app.component("v-icon", OhVueIcon);
+app.mount("#app");
+```
+
  
@@ -92,11 +125,12 @@
 ```js
-import OhVueIcon from 'oh-vue-icons/components/Icon'
+import OhVueIcon from "oh-vue-icons/components/icon";
 
 export default {
   components: {
-    'v-icon': OhVueIcon
+    "v-icon": OhVueIcon
   }
-}
+};
 ```
 
+
  
@@ -177,2 +211,2 @@
 
-本项目使用 [MIT](LICENSE) 开源协议。图标来自于[其他项目](#readme)，所以还需要参考这些项目的开源协议。
+本项目使用 [MIT](LICENSE) 开源协议。图标来自于[其他项目](#支持的图标库)，所以还需要参考这些项目的开源协议。

README.md

@@ -7,4 +7,18 @@ # Oh, Vue Icons!
 
-A [Vue](https://vuejs.org/) component for including inline SVG icons from different popular iconpacks easily. It is tree-shakable and allows only importing the used icons.
+A [Vue](https://vuejs.org/) component for including inline SVG icons from different popular icon packs easily.
 
+
+ 
+
+## Features
+
+- Tree-shakable, which allows you to only import the used icons
+- Supports Vue 2 and Vue 3
+- Supports 15 popular icon packs, see [here](#supported-icon-packs)
+
+
+ 
+
+## Supported Icon Packs
+
 Now the following 15 icon packs are supported:
@@ -24,5 +38,5 @@
 | [Pokemon Icons](https://theartificial.github.io/pokemon-icons/) (Colorful)| `pi`   | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) | 1453      |
-| [Pixel Icons](https://pixelarticons.com/)                     | `px`   | [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) | 451       |
+| [Pixelarticons](https://pixelarticons.com/)                   | `px`   | [MIT](https://github.com/halfmage/pixelarticons/blob/master/LICENSE) | 460       |
 | [Remix Icon](https://github.com/Remix-Design/RemixIcon)       | `ri`   | [Apache 2.0](https://github.com/Remix-Design/RemixIcon/blob/master/License) | 2271       |
-| [Simple Icons](https://simpleicons.org/)                      | `si`   | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1799       |
+| [Simple Icons](https://simpleicons.org/)                      | `si`   | [CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md) | 1831       |
 | [VSCode Icons](https://github.com/vscode-icons/vscode-icons) (Colorful) | `vi`   | [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) | 1061       |
@@ -49,2 +63,3 @@ | [Weather Icons](https://erikflowers.github.io/weather-icons/) | `wi`   | [SIL OFL 1.1](http://scripts.sil.org/OFL)                     | 219        |
 
+
  
@@ -56,18 +71,20 @@
 
-Import `oh-vue-icons` and install it into Vue in `main.js`. You can only import the icons you need to reduce the bundle size, for example:
+Import `oh-vue-icons` and install it into Vue in `main.js`. You can only import the icons you need to reduce the bundle size.
 
+#### Vue 2
+
 ```js
 // main.js
-import Vue from 'vue'
-import App from './App.vue'
-import OhVueIcon from 'oh-vue-icons/components/Icon'
+import Vue from "vue";
+import App from "./App.vue";
+import OhVueIcon from "oh-vue-icons/components/icon";
 
-import { FaFlag, RiZhihuFill } from 'oh-vue-icons/icons'
-OhVueIcon.add([FaFlag, RiZhihuFill])
+import { FaFlag, RiZhihuFill } from "oh-vue-icons/icons";
+OhVueIcon.add([FaFlag, RiZhihuFill]);
 
-Vue.component('v-icon', OhVueIcon)
+Vue.component("v-icon", OhVueIcon);
 
 new Vue({
   render: h => h(App)
-}).$mount('#app')
+}).$mount("#app");
 ```
@@ -80,8 +97,24 @@
 // import Font Awesome
-import * as FaIcons from 'oh-vue-icons/icons/fa'
+import * as FaIcons from "oh-vue-icons/icons/fa";
 
-const Fa = Object.values({ ...FaIcons })
-OhVueIcon.add(Fa)
+const Fa = Object.values({ ...FaIcons });
+OhVueIcon.add(Fa);
 ```
 
+#### Vue 3
+
+```js
+// main.js
+import { createApp } from "vue";
+import App from "./App.vue";
+import OhVueIcon from "oh-vue-icons/components/icon-v3";
+
+import { FaFlag, RiZhihuFill } from "oh-vue-icons/icons";
+OhVueIcon.add([FaFlag, RiZhihuFill]);
+
+const app = createApp(App);
+app.component("v-icon", OhVueIcon);
+app.mount("#app");
+```
+
  
@@ -92,11 +125,12 @@
 ```js
-import OhVueIcon from 'oh-vue-icons/components/Icon'
+import OhVueIcon from "oh-vue-icons/components/icon";
 
 export default {
   components: {
-    'v-icon': OhVueIcon
+    "v-icon": OhVueIcon
   }
-}
+};
 ```
 
+
  
@@ -177,2 +211,2 @@
 
-This project is [MIT](LICENSE) licensed. Icons are taken from [other projects](#readme), so check the license of each accordingly.
+This project is [MIT](LICENSE) licensed. Icons are taken from [other projects](#supported-icon-packs), so check the license of each accordingly.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

31851030

increased by0.16%

Dev dependency count

16

decreased by-5.88%

Number of package files

41

increased by2.5%

Lines of code

54864

increased by1.43%

Number of lines in readme file

206

increased by19.77%

No dependency changes