Skip to content

Commit f0b5b6a

Browse files
mrholekmrholek
committed
release: v2.0.0
1 parent 868bd4c commit f0b5b6a

21 files changed

+449
-13305
lines changed

‎.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/dist/**
2+
.eslintrc.js

‎.eslintrc.js

+26-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
11
module.exports = {
2-
'extends': [
3-
'plugin:vue/essential',
4-
'eslint:recommended'
2+
parser: '@typescript-eslint/parser', // Specifies the ESLint parser
3+
parserOptions: {
4+
ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
5+
sourceType: 'module', // Allows for the use of imports
6+
extraFileExtensions: ['.vue'],
7+
ecmaFeatures: {
8+
jsx: true,
9+
},
10+
},
11+
extends: [
12+
'plugin:vue/vue3-essential',
13+
'eslint:recommended',
14+
'@vue/typescript/recommended',
15+
'@vue/prettier',
16+
'@vue/prettier/@typescript-eslint',
517
],
618
rules: {
7-
'vue/return-in-computed-property': 'off',
8-
'no-undef': 'off'
9-
}
19+
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
20+
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
21+
},
22+
overrides: [
23+
{
24+
files: ['**/__tests__/*.{j,t}s?(x)', '**/tests/unit/**/*.spec.{j,t}s?(x)'],
25+
env: {
26+
jest: true,
27+
},
28+
},
29+
],
1030
}

‎.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Enforce Unix newlines
2+
* text=auto eol=lf

‎.gitignore

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
.DS_Store
22
.git
3-
.idea
3+
.vscode
4+
_old
45
node_modules
5-
dist
6+
test
7+
.cache
8+
coverage/
9+
dist/
10+
public/
11+
yarn.lock

‎.prettierrc.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
semi: false,
3+
trailingComma: "all",
4+
singleQuote: true,
5+
printWidth: 100,
6+
tabWidth: 2
7+
};

‎LICENSE

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

‎README.md

+61-25
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,79 @@
1-
# CoreUI Icons Vue
1+
<p align="center">
2+
<a href="https://coreui.io/">
3+
<img src="https://coreui.io/images/brand/coreui-icons.svg" alt="CoreUI Icons logo" height="50">
4+
</a>
5+
</p>
6+
7+
<p align="center">
8+
Official Vue.js component for CoreUI Icons and CoreUI Icons PRO.
9+
<br>
10+
<a href="https://coreui.io/vue/docs/components/icon.html"><strong>Explore CoreUI Icons for Vue docs »</strong></a>
11+
<br>
12+
<br>
13+
<a href="https://github.com/coreui/coreui-icons/issues/new?template=bug_report.md">Report bug</a>
14+
·
15+
<a href="https://github.com/coreui/coreui-icons/issues/new?template=feature_request.md">Request feature</a>
16+
·
17+
<a href="https://blog.coreui.io/">Blog</a>
18+
</p>
19+
20+
21+
22+
## Status
223

324
[![NPM](https://img.shields.io/npm/v/@coreui/icons-vue/latest?style=flat-square&color=brightgreen)][coreui]
425
[![Downloads](https://img.shields.io/npm/dm/@coreui/icons-vue.svg?style=flat-square)][coreui]
526
[![License](https://img.shields.io/npm/l/@coreui/vue?style=flat-square)][coreui]
627

728
[coreui]: https://coreui.io/icons
829

9-
## CIcon component
1030

11-
Dedicated component used to implement [CoreUI Icons SVG set](https://coreui.io/icons/) in Vue.js.
31+
## Installation
32+
33+
```bash
34+
npm install @coreui/icons
35+
npm install @coreui/icons-vue
36+
```
1237

13-
### Features
38+
or
1439

15-
- Can load icons in three ways:
16-
- stored globally in Vue root object,
17-
- directly passed SVG tag content,
18-
- source link to SVG file
19-
- Greatly reduce icons bundle size, when imported as single icons,
20-
- Full functionality of 'svg' html tag,
21-
- Clean API
40+
```bash
41+
yarn add @coreui/icons
42+
yarn add @coreui/icons-vue
43+
```
2244

23-
For component description visit [CIcon component documentation](https://coreui.io/vue/docs/components/icon)
45+
## Use
2446

25-
### Installation
47+
### Single icon
2648

27-
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:
49+
```jsx
50+
import { CIcon } from '@coreui/icons-vue';
51+
import { cifAu } from '@coreui/icons';
2852

29-
```shell
30-
npm install @coreui/icons-vue --save
53+
...
54+
<CIcon :icon="cilAu" size="xxl"/>
55+
...
3156
```
3257

33-
### License
58+
### All icons
59+
60+
```jsx
61+
import { CIcon } from '@coreui/icons-vue';
62+
import * as icon from '@coreui/icons';
63+
64+
...
65+
<CIcon :icon="icon.cilList" size="xxl"/>
66+
...
67+
```
3468

35-
CoreUI Icons Free is free, open source, and GPL friendly. You can use it for
36-
commercial projects, open source projects, or really almost whatever you want.
69+
## API
3770

38-
- Icons — CC BY 4.0 License
39-
- In the CoreUI Icons Free download, the CC BY 4.0 license applies to all icons packaged as .svg and .js files types.
40-
- Fonts — SIL OFL 1.1 License
41-
- In the CoreUI Icons Free download, the SIL OLF license applies to all icons packaged as web and desktop font files.
42-
- Code — MIT License
43-
- In the CoreUI Icons Free download, the MIT license applies to all non-font and non-icon files.
71+
| property | type | description |
72+
| --- | --- | --- |
73+
| customClassName | `string` \| `object` \| `string[]` | Use for replacing default CIcon component classes. Prop is overriding the 'size' prop. |
74+
| icon | `string` \| `string[]` | Name of the icon placed in React object or SVG content. |
75+
| height | `number` | The height attribute defines the vertical length of an icon. |
76+
| size | `sm` \| `md` \|`lg` \| `xl` \| `xxl` \| `3xl` \| `4xl` \| `5xl` \| `6xl` \| `7xl` \| `8xl` \| `9xl` | Size of the icon. |
77+
| use | `string` | If defined component will be rendered using `use` tag. |
78+
| title | `string` | Title tag content. |
79+
| width | `number` | The width attribute defines the horizontal length of an icon. |

‎babel.config.js

-5
This file was deleted.

‎jest.config.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/**
2+
* Copyright (c) 2013-present, creativeLabs Lukasz Holeczek.
3+
*
4+
* This source code is licensed under the MIT license found in the
5+
* LICENSE file in the root directory of this source tree.
6+
*/
7+
8+
'use strict'
9+
10+
module.exports = {
11+
moduleFileExtensions: ['tsx', 'js', 'ts', 'json', 'vue'],
12+
preset: 'ts-jest',
13+
testEnvironment: 'jsdom',
14+
transform: {
15+
'.*\\.(ts)$': 'ts-jest',
16+
},
17+
}

0 commit comments

Comments
 (0)