release: v2.0.0

.eslintignore

@@ -0,0 +1,2 @@
+/dist/**
+.eslintrc.js

.eslintrc.js

@@ -1,10 +1,30 @@
 module.exports = {
-  'extends': [
-    'plugin:vue/essential',
-    'eslint:recommended'
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  parserOptions: {
+    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+    extraFileExtensions: ['.vue'],
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+  extends: [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/typescript/recommended',
+    '@vue/prettier',
+    '@vue/prettier/@typescript-eslint',
   ],
   rules: {
-    'vue/return-in-computed-property': 'off',
-    'no-undef': 'off'
-  }
+    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+  },
+  overrides: [
+    {
+      files: ['**/__tests__/*.{j,t}s?(x)', '**/tests/unit/**/*.spec.{j,t}s?(x)'],
+      env: {
+        jest: true,
+      },
+    },
+  ],
 }

.gitattributes

@@ -0,0 +1,2 @@
+# Enforce Unix newlines
+* text=auto eol=lf

.gitignore

@@ -1,5 +1,11 @@
 .DS_Store
 .git
-.idea
+.vscode
+_old
 node_modules
-dist
+test
+.cache
+coverage/
+dist/
+public/
+yarn.lock

.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: false,
+  trailingComma: "all",
+  singleQuote: true,
+  printWidth: 100,
+  tabWidth: 2
+};

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 creativeLabs Łukasz Holeczek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,43 +1,79 @@
-# 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://blog.coreui.io/">Blog</a>
+</p>
+
+
+
+## Status
 
 [![NPM](https://img.shields.io/npm/v/@coreui/icons-vue/latest?style=flat-square&color=brightgreen)][coreui]
 [![Downloads](https://img.shields.io/npm/dm/@coreui/icons-vue.svg?style=flat-square)][coreui]
 [![License](https://img.shields.io/npm/l/@coreui/vue?style=flat-square)][coreui]
 
 [coreui]: https://coreui.io/icons
 
-## CIcon component
 
-Dedicated component used to implement [CoreUI Icons SVG set](https://coreui.io/icons/) in Vue.js.
+## Installation
+
+```bash
+npm install @coreui/icons
+npm install @coreui/icons-vue
+```
 
-### Features
+or
 
-- 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
+```bash
+yarn add @coreui/icons
+yarn add @coreui/icons-vue
+```
 
-For component description visit [CIcon component documentation](https://coreui.io/vue/docs/components/icon)
+## Use
 
-### Installation
+### Single icon
 
-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:
+```jsx
+import { CIcon } from '@coreui/icons-vue';
+import { cifAu } from '@coreui/icons';
 
-```shell
-npm install @coreui/icons-vue --save
+...
+<CIcon :icon="cilAu" size="xxl"/>
+...
 ```
 
-### License
+### All icons
+
+```jsx
+import { CIcon } from '@coreui/icons-vue';
+import * as icon from '@coreui/icons';
+
+...
+<CIcon :icon="icon.cilList" size="xxl"/>
+...
+```
 
-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.
+## API
 
-- 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.
+| 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. |

jest.config.js

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2013-present, creativeLabs Lukasz Holeczek.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict'
+
+module.exports = {
+  moduleFileExtensions: ['tsx', 'js', 'ts', 'json', 'vue'],
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  transform: {
+    '.*\\.(ts)$': 'ts-jest',
+  },
+}