Skip to content

Commit e2a9da8

Browse files
committed
refactor: create monorepo
1 parent a599c29 commit e2a9da8

21 files changed

+8744
-11194
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
# EditorConfig is awesome: https://EditorConfig.org
2+
3+
# top-most EditorConfig file
14
root = true
25

36
[*]
47
indent_style = space
58
indent_size = 2
9+
end_of_line = lf
610
charset = utf-8
711
trim_trailing_whitespace = false
812
insert_final_newline = false

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Enforce Unix newlines
2+
* text=auto eol=lf
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@
44
_old
55
node_modules
66
test
7+
.cache
8+
coverage/
9+
dist/
10+
public/
File renamed without changes.

README.md

Lines changed: 302 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,302 @@
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+
Open Source icons set with over 1500 simply beautiful icons, and components for Angular, React.js & Vue.js.
9+
<br>
10+
<a href="https://icons.coreui.io/docs/"><strong>Explore CoreUI Iconsdocs »</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://community.coreui.io/">Community</a>
18+
·
19+
<a href="https://blog.coreui.io/">Blog</a>
20+
</p>
21+
22+
![CoreUI Free Icons](https://coreui.io/images/icons_free_bg_set.png)
23+
24+
## Table of Contents
25+
26+
- [Preview & Docs](#preview--docs)
27+
- [Installation](#installation)
28+
- [CDN](#cdn)
29+
- [NPM](#npm)
30+
- [Yarn](#yarn)
31+
- [Usage](#usage)
32+
- [Basic Use](#basic-use)
33+
- [SVG Sprites](#svg-sprites)
34+
- [SVG Symbols](#svg-symbols)
35+
- [Usage with Frameworks](#usage)
36+
- [Angular](#angular)
37+
- [React.js](#reactjs)
38+
- [Vue.js](#vuejs)
39+
- [CoreUI Icons PRO](#coreui-icons-pro)
40+
- [License](#license)
41+
- [CoreUI Icons Free Icons](#coreui-icons-free-icons)
42+
- [CoreUI Icons Brand and Flag Icons](#coreui-icons-brand-and-flag-icons)
43+
- [Brand Icons](#brand-icons)
44+
45+
## Preview & Docs
46+
47+
[https://coreui.io/icons/](https://coreui.io/icons/)
48+
49+
50+
## Installation
51+
52+
### CDN
53+
54+
```html
55+
<link rel="stylesheet" href="https://unpkg.com/@coreui/icons/css/all.min.css">
56+
```
57+
58+
or
59+
60+
```html
61+
<link rel="stylesheet" href="https://unpkg.com/@coreui/icons/css/free.min.css">
62+
<link rel="stylesheet" href="https://unpkg.com/@coreui/icons/css/brand.min.css">
63+
<link rel="stylesheet" href="https://unpkg.com/@coreui/icons/css/flag.min.css">
64+
```
65+
66+
### NPM
67+
68+
```shell
69+
npm install @coreui/icons --save
70+
```
71+
72+
### Yarn
73+
74+
```shell
75+
yarn add @coreui/icons
76+
```
77+
78+
Or, you can also clone or [download this repository](https://github.com/coreui/coreui-icons/archive/main.zip) as zip.
79+
80+
## Usage
81+
82+
### Basic Use
83+
You can place CoreUI Icons just about anywhere using a CSS style prefix and the icon’s name. CoreUI Icons are designed to be used with inline elements ex. `<i>` or `<span>`.
84+
85+
Please use `cil-` prefix for linear icons, `cib-` prefix for brand icons, and `cif-` prefix for flag icons.
86+
87+
```html
88+
<i class="cil-energy"></i>
89+
<i class="cib-twitter"></i>
90+
<i class="cif-us"></i>
91+
```
92+
93+
### SVG Sprites
94+
95+
SVG sprites let you quickly use vector icons in your website. We have prepared all the icon set styles into their own SVG sprites.
96+
97+
Place sprite files with the rest of your static files, like images and styles, in your project. Make sure to add a proper path to the SVG sprite file, and use the fragment identifier specific to the SVG icon or symbol you want to display.
98+
99+
```html
100+
<svg>
101+
<use xlink:href="path/to/free.svg#cil-airplane-mode"></use>
102+
</svg>
103+
<svg>
104+
<use xlink:href="path/to/brand.svg#cib-twitter"></use>
105+
</svg>
106+
<svg>
107+
<use xlink:href="path/to/flag.svg#cif-us"></use>
108+
</svg>
109+
```
110+
111+
112+
### SVG Symbols
113+
114+
When you download your icon set, it comes with a sprites directory that contains SVG icon definitions. These icons can be referenced and used as inline SVGs like so:
115+
116+
```html
117+
<!-- Define the symbols -->
118+
<symbol id="cil-apple" viewBox="0 0 24 24">
119+
<title>apple</title>
120+
<path d="M21.207 9.987c-0.497-1.275-1.29-2.262-2.293-2.863-0.25 0.477-0.524 0.888-0.835 1.267l0.010-0.013c0.002 0.001 0.004 0.002 0.005 0.003 1.494 0.859 2.364 3.054 2.114 5.338-0.414 3.784-1.563 6.377-3.236 7.302-1.087 0.601-2.444 0.516-4.031-0.254l-0.155-0.075h-1.143l-0.155 0.075c-1.588 0.77-2.944 0.856-4.031 0.254-1.673-0.925-2.822-3.518-3.236-7.302-0.25-2.284 0.619-4.479 2.114-5.338 0.445-0.259 0.979-0.411 1.549-0.411 0.011 0 0.023 0 0.034 0l-0.002-0c1.132 0 2.436 0.53 3.853 1.578l0.051 0.037s2.043-0.248 2.852-0.616c2.439-1.107 2.976-2.867 3.072-3.106 0.262-0.632 0.414-1.366 0.414-2.135 0-0.813-0.17-1.587-0.476-2.287l0.014 0.037-0.191-0.477-0.513 0.005c-3.151 0.036-5.692 2.598-5.692 5.755 0 0.255 0.017 0.507 0.049 0.754l-0.003-0.029c-0.886-0.496-1.747-0.813-2.573-0.944-1.169-0.186-2.241-0.005-3.186 0.538-1.038 0.596-1.855 1.601-2.364 2.906-0.463 1.186-0.638 2.57-0.493 3.895 0.475 4.344 1.859 7.267 4.001 8.452 0.655 0.37 1.438 0.588 2.272 0.588 0.010 0 0.021-0 0.031-0h-0.002c0.918-0 1.904-0.244 2.952-0.73h0.461c1.987 0.923 3.754 0.971 5.253 0.142 2.142-1.185 3.526-4.107 4.001-8.452 0.145-1.325-0.030-2.709-0.493-3.895zM15.376 2.851c0.322-0.143 0.697-0.251 1.088-0.305l0.022-0.003c0.106 0.354 0.167 0.761 0.167 1.182 0 2.15-1.593 3.927-3.663 4.215l-0.022 0.003c-0.106-0.354-0.167-0.76-0.167-1.181 0-1.743 1.048-3.242 2.547-3.901l0.027-0.011z"></path>
121+
</symbol>
122+
123+
<!-- Use the defined symbols -->
124+
<svg>
125+
<use xlink:href="#cil-apple"></use>
126+
</svg>
127+
```
128+
129+
It is also possible to link to an external SVG containing the definitions:
130+
131+
```html
132+
<svg class="icon-home">
133+
<use xlink:href="path/to/free.svg#cil-apple"></use>
134+
</svg>
135+
```
136+
137+
Referencing an external SVG has the advantage that your icons get cached, with one HTTP request. But the external SVG and the HTML should be served from the same domain. This approach works fine in modern browsers except for IE 9+. In order to support IE 9+, You should use `/js/svgxuse.js` or `/js/svgxuse.min.js`. This polyfill detects if the icons are loaded properly; if they aren't, it sends one HTTP request to fetch and cache symbol definitions.
138+
139+
```html
140+
<script defer src="https://unpkg.com/@coreui/icons/js/svgxuse.js"></script>
141+
```
142+
143+
## Usage with frameworks
144+
145+
If you are using a framework, CoreUI Icons are delivered with official components for Angular, React, and Vue.
146+
147+
### Angular
148+
149+
- Please check official repository [CoreUI Icons for Angular](https://github.com/coreui/coreui-icons-angular)
150+
151+
### CoreUI Icons for React.js
152+
153+
- [CoreUI Icons for React](https://github.com/coreui/coreui-icons/packages/icons-react)
154+
155+
### CoreUI Icons for Vue.js
156+
157+
- [CoreUI Icons for Vue](https://github.com/coreui/coreui-icons/packages/icons-vue)
158+
159+
## CoreUI Icons PRO
160+
161+
If our free icon set is insufficient you can buy [CoreUI Icons Pro](https://coreui.io/icons/pro/) with more than 2000 icons, and more styles - Solid, Duo-Tone and Linear.
162+
163+
## License
164+
165+
### CoreUI Icons Free Icons
166+
167+
CoreUI Icons Free is free, open source, and GPL friendly. You can use it for
168+
commercial projects, open source projects, or really almost whatever you want.
169+
170+
- Icons — CC BY 4.0 License
171+
- In the CoreUI Icons Free, the CC BY 4.0 license applies to all icons
172+
packaged as .svg and .js files types.
173+
- Fonts — SIL OFL 1.1 License
174+
- In the CoreUI Icons Free, the SIL OLF license applies to all icons
175+
packaged as web and desktop font files.
176+
- Code — MIT License
177+
- In the CoreUI Icons Free, the MIT license applies to all
178+
non-font and non-icon files.
179+
180+
### CoreUI Icons Brand and Flag Icons
181+
182+
#### Brand Icons
183+
All brand icons are trademarks of their respective owners. The use of these
184+
trademarks does not indicate endorsement of the trademark holder by Font
185+
Awesome, nor vice versa. **Please do not use brand logos for any purpose except
186+
to represent the company, product, or service to which they refer.**
187+
188+
**CC0 1.0 Universal**
189+
Statement of Purpose
190+
191+
The laws of most jurisdictions throughout the world automatically confer
192+
exclusive Copyright and Related Rights (defined below) upon the creator and
193+
subsequent owner(s) (each and all, an "owner") of an original work of
194+
authorship and/or a database (each, a "Work").
195+
196+
Certain owners wish to permanently relinquish those rights to a Work for the
197+
purpose of contributing to a commons of creative, cultural and scientific
198+
works ("Commons") that the public can reliably and without fear of later
199+
claims of infringement build upon, modify, incorporate in other works, reuse
200+
and redistribute as freely as possible in any form whatsoever and for any
201+
purposes, including without limitation commercial purposes. These owners may
202+
contribute to the Commons to promote the ideal of a free culture and the
203+
further production of creative, cultural and scientific works, or to gain
204+
reputation or greater distribution for their Work in part through the use and
205+
efforts of others.
206+
207+
For these and/or other purposes and motivations, and without any expectation
208+
of additional consideration or compensation, the person associating CC0 with a
209+
Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
210+
and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
211+
and publicly distribute the Work under its terms, with knowledge of his or her
212+
Copyright and Related Rights in the Work and the meaning and intended legal
213+
effect of CC0 on those rights.
214+
215+
1. Copyright and Related Rights. A Work made available under CC0 may be
216+
protected by copyright and related or neighboring rights ("Copyright and
217+
Related Rights"). Copyright and Related Rights include, but are not limited
218+
to, the following:
219+
220+
i. the right to reproduce, adapt, distribute, perform, display, communicate,
221+
and translate a Work;
222+
223+
ii. moral rights retained by the original author(s) and/or performer(s);
224+
225+
iii. publicity and privacy rights pertaining to a person's image or likeness
226+
depicted in a Work;
227+
228+
iv. rights protecting against unfair competition in regards to a Work,
229+
subject to the limitations in paragraph 4(a), below;
230+
231+
v. rights protecting the extraction, dissemination, use and reuse of data in
232+
a Work;
233+
234+
vi. database rights (such as those arising under Directive 96/9/EC of the
235+
European Parliament and of the Council of 11 March 1996 on the legal
236+
protection of databases, and under any national implementation thereof,
237+
including any amended or successor version of such directive); and
238+
239+
vii. other similar, equivalent or corresponding rights throughout the world
240+
based on applicable law or treaty, and any national implementations thereof.
241+
242+
2. Waiver. To the greatest extent permitted by, but not in contravention of,
243+
applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
244+
unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
245+
and Related Rights and associated claims and causes of action, whether now
246+
known or unknown (including existing as well as future claims and causes of
247+
action), in the Work (i) in all territories worldwide, (ii) for the maximum
248+
duration provided by applicable law or treaty (including future time
249+
extensions), (iii) in any current or future medium and for any number of
250+
copies, and (iv) for any purpose whatsoever, including without limitation
251+
commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
252+
the Waiver for the benefit of each member of the public at large and to the
253+
detriment of Affirmer's heirs and successors, fully intending that such Waiver
254+
shall not be subject to revocation, rescission, cancellation, termination, or
255+
any other legal or equitable action to disrupt the quiet enjoyment of the Work
256+
by the public as contemplated by Affirmer's express Statement of Purpose.
257+
258+
3. Public License Fallback. Should any part of the Waiver for any reason be
259+
judged legally invalid or ineffective under applicable law, then the Waiver
260+
shall be preserved to the maximum extent permitted taking into account
261+
Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
262+
is so judged Affirmer hereby grants to each affected person a royalty-free,
263+
non transferable, non sublicensable, non exclusive, irrevocable and
264+
unconditional license to exercise Affirmer's Copyright and Related Rights in
265+
the Work (i) in all territories worldwide, (ii) for the maximum duration
266+
provided by applicable law or treaty (including future time extensions), (iii)
267+
in any current or future medium and for any number of copies, and (iv) for any
268+
purpose whatsoever, including without limitation commercial, advertising or
269+
promotional purposes (the "License"). The License shall be deemed effective as
270+
of the date CC0 was applied by Affirmer to the Work. Should any part of the
271+
License for any reason be judged legally invalid or ineffective under
272+
applicable law, such partial invalidity or ineffectiveness shall not
273+
invalidate the remainder of the License, and in such case Affirmer hereby
274+
affirms that he or she will not (i) exercise any of his or her remaining
275+
Copyright and Related Rights in the Work or (ii) assert any associated claims
276+
and causes of action with respect to the Work, in either case contrary to
277+
Affirmer's express Statement of Purpose.
278+
279+
4. Limitations and Disclaimers.
280+
281+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
282+
surrendered, licensed or otherwise affected by this document.
283+
284+
b. Affirmer offers the Work as-is and makes no representations or warranties
285+
of any kind concerning the Work, express, implied, statutory or otherwise,
286+
including without limitation warranties of title, merchantability, fitness
287+
for a particular purpose, non infringement, or the absence of latent or
288+
other defects, accuracy, or the present or absence of errors, whether or not
289+
discoverable, all to the greatest extent permissible under applicable law.
290+
291+
c. Affirmer disclaims responsibility for clearing rights of other persons
292+
that may apply to the Work or any use thereof, including without limitation
293+
any person's Copyright and Related Rights in the Work. Further, Affirmer
294+
disclaims responsibility for obtaining any necessary consents, permissions
295+
or other rights required for any use of the Work.
296+
297+
d. Affirmer understands and acknowledges that Creative Commons is not a
298+
party to this document and has no duty or obligation with respect to this
299+
CC0 or use of the Work.
300+
301+
For more information, please see
302+
<http://creativecommons.org/publicdomain/zero/1.0/>

lerna.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
2+
"npmClient": "yarn",
23
"packages": [
34
"packages/*"
45
],
5-
"version": "0.0.0"
6+
"useWorkspaces": true,
7+
"version": "independent"
68
}

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
2-
"name": "root",
32
"private": true,
3+
"workspaces": [
4+
"packages/*"
5+
],
46
"devDependencies": {
57
"lerna": "^4.0.0"
68
}

0 commit comments

Comments
 (0)