@coreui/icons-vue - npm Package Compare versions

Comparing version 2.0.0-rc.0 to 2.0.0-rc.1

dist/index.es.js

@@ -56,3 +56,3 @@ import { defineComponent, inject, computed, h } from 'vue';
                     'xl',
-                    '2xl',
+                    'xxl',
                     '3xl',
@@ -59,0 +59,0 @@ '4xl',

dist/index.js

@@ -60,3 +60,3 @@ 'use strict';
                     'xl',
-                    '2xl',
+                    'xxl',
                     '3xl',
@@ -63,0 +63,0 @@ '4xl',

package.json

 {
   "name": "@coreui/icons-vue",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0-rc.1",
+  "description": "Official Vue component for CoreUI Icons",
+  "keywords": [
+    "coreui",
+    "coreui-icons",
+    "coreui-vue",
+    "icons",
+    "svg",
+    "svg-icons",
+    "layout",
+    "component",
+    "vue"
+  ],
+  "homepage": "https://icons.coreui.io",
+  "bugs": {
+    "url": "https://github.com/coreui/coreui-icons/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coreui/coreui-icons.git"
+  },
   "license": "MIT",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
-  "jsnext:main": "dist/index.es.js",
-  "files": [
-    "src",
-    "dist"
-  ],
-  "homepage": "https://coreui.io",
   "author": {
@@ -25,24 +37,37 @@ "name": "CoreUI",
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/coreui/coreui-icons-vue.git"
-  },
-  "bugs": {
-    "url": "https://github.com/coreui/coreui-icons-vue/issues"
-  },
-  "keywords": [
-    "coreui",
-    "coreui-icons",
-    "coreui-vue",
-    "icons",
-    "svg",
-    "svg-icons",
-    "layout",
-    "component",
-    "vue"
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "jsnext:main": "dist/index.es.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "src/"
   ],
   "scripts": {
     "build": "rollup -c",
-    "lint": "eslint 'src/**/*.{js,ts,tsx}'"
+    "lint": "eslint 'src/**/*.{js,ts,tsx}'",
+    "test": "jest",
+    "test:clear": "jest --clearCache",
+    "test:coverage": "jest --coverage",
+    "test:u": "jest -u"
   },
+  "browserslist": [
+    "> 1%",
+    "last 2 versions",
+    "not ie <= 8"
+  ],
+  "jest": {
+    "moduleFileExtensions": [
+      "tsx",
+      "js",
+      "ts",
+      "json",
+      "vue"
+    ],
+    "preset": "ts-jest",
+    "testEnvironment": "jsdom",
+    "transform": {
+      ".*\\.(ts)$": "ts-jest"
+    }
+  },
   "devDependencies": {
@@ -57,2 +82,3 @@ "@rollup/plugin-commonjs": "^21.0.0",
     "@vue/eslint-config-typescript": "^7.0.0",
+    "@vue/test-utils": "^2.0.0-0",
     "eslint": "^7.32.0",
@@ -62,2 +88,3 @@ "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-vue": "^7.19.1",
+    "jest": "^27.3.0",
     "prettier": "^2.4.1",
@@ -67,2 +94,3 @@ "rollup": "^2.58.0",
     "rollup-plugin-vue": "^6.0.0",
+    "ts-jest": "^27.0.7",
     "typescript": "^4.4.3",
@@ -73,8 +101,3 @@ "vue": "^3.2.20"
     "vue": "^3.2.20"
-  },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not ie <= 8"
-  ]
+  }
 }

README.md

@@ -1,3 +0,26 @@
-# CoreUI Icons Vue
+<p align="center">
+  <a href="https://coreui.io/">
+    <img src="https://coreui.io/images/brand/coreui-icons.svg" alt="CoreUI Icons logo" height="50">
+  </a>
+</p>
 
+<p align="center">
+  Official Vue.js component for CoreUI Icons and CoreUI Icons PRO.
+  <br>
+  <a href="https://coreui.io/vue/docs/components/icon.html"><strong>Explore CoreUI Icons for Vue docs »</strong></a>
+  <br>
+  <br>
+  <a href="https://github.com/coreui/coreui-icons/issues/new?template=bug_report.md">Report bug</a>
+  ·
+  <a href="https://github.com/coreui/coreui-icons/issues/new?template=feature_request.md">Request feature</a>
+  ·
+  <a href="https://community.coreui.io/">Community</a>
+  ·
+  <a href="https://blog.coreui.io/">Blog</a>
+</p>
+
+
+
+## Status
+
 [![NPM](https://img.shields.io/npm/v/@coreui/icons-vue/latest?style=flat-square&color=brightgreen)][coreui]
@@ -9,36 +32,51 @@ [![Downloads](https://img.shields.io/npm/dm/@coreui/icons-vue.svg?style=flat-square)][coreui]
 
-## CIcon component
 
-Dedicated component used to implement [CoreUI Icons SVG set](https://coreui.io/icons/) in Vue.js.
+## Installation
 
-### Features
+```bash
+npm install @coreui/icons
+npm install @coreui/icons-vue@next
+```
 
-- Can load icons in three ways:
-  - stored globally in Vue root object,
-  - directly passed SVG tag content,
-  - source link to SVG file
-- Greatly reduce icons bundle size, when imported as single icons,
-- Full functionality of 'svg' html tag,
-- Clean API
+or
 
-For component description visit [CIcon component documentation](https://coreui.io/vue/docs/components/icon)
+```bash
+yarn add @coreui/icons
+yarn add @coreui/icons-vue@next
+```
 
-### Installation
+## Use
 
-If you already have installed [CoreUI Vue component library](https://coreui.io/vue/docs) plugin, then you have CIcon component already installed, otherwise install package by:
+### Single icon
 
-```shell
-npm install @coreui/icons-vue --save
+```jsx
+import { CIcon } from '@coreui/icons-vue';
+import { cifAu } from '@coreui/icons';
+
+...
+<CIcon :icon="cilAu" size="xxl"/>
+...
 ```
 
-### License
+### All icons
 
-CoreUI Icons Free is free, open source, and GPL friendly. You can use it for
-commercial projects, open source projects, or really almost whatever you want.
+```jsx
+import { CIcon } from '@coreui/icons-vue';
+import * as icon from '@coreui/icons';
 
-- Icons — CC BY 4.0 License
-  - In the CoreUI Icons Free download, the CC BY 4.0 license applies to all icons packaged as .svg and .js files types.
-- Fonts — SIL OFL 1.1 License
-  - In the CoreUI Icons Free download, the SIL OLF license applies to all icons packaged as web and desktop font files.
-- Code — MIT License
-  - In the CoreUI Icons Free download, the MIT license applies to all non-font and non-icon files.
+...
+<CIcon :icon="icon.cilList" size="xxl"/>
+...
+```
+
+## API
+
+| property | type | description |
+| --- | --- | --- |
+| customClassName | `string` \| `object` \| `string[]` | Use for replacing default CIcon component classes. Prop is overriding the 'size' prop. |
+| icon | `string` \| `string[]` | Name of the icon placed in React object or SVG content. |
+| height | `number` | The height attribute defines the vertical length of an icon. |
+| size | `sm` \| `md` \|`lg` \| `xl` \| `xxl` \| `3xl` \| `4xl` \| `5xl` \| `6xl` \| `7xl` \| `8xl` \| `9xl` | Size of the icon. |
+| use | `string` | If defined component will be rendered using `use` tag. |
+| title | `string` | Title tag content. |
+| width | `number` | The width attribute defines the horizontal length of an icon. |

src/CIcon.ts

@@ -56,3 +56,3 @@ import { computed, defineComponent, h, inject, PropType } from 'vue'
           'xl',
-          '2xl',
+          'xxl',
           '3xl',
@@ -59,0 +59,0 @@ '4xl',

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

27742

increased by13.84%

Number of package files

12

increased by20%

Lines of code

518

increased by5.93%

Number of lines in readme file

82

increased by86.36%

Worsened metrics

Dev dependency count

21

increased by16.67%

No dependency changes