@ng-icons/ionicons 13.0.0 → 13.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,90 +1,100 @@
1
- # Ng Icons
2
-
3
- The all-in-one icon library for Angular. This allows you to use icons from multiple icon sets with a single icon component.
4
- Containing over 7000+ icons for you to use in your projects.
5
-
6
- Currently, we support the following libraries:
7
-
8
- - [Bootstrap Icons](https://icons.getbootstrap.com/)
9
- - [Heroicons](https://heroicons.com/)
10
- - [Ionicons](https://ionic.io/ionicons)
11
- - [CSS.gg](https://css.gg/)
12
- - [Feather Icons](https://feathericons.com/)
13
- - [Jam Icons](https://jam-icons.com/)
14
- - [Octicons](https://github.com/primer/octicons)
15
- - [Radix UI Icons](https://icons.modulz.app/)
16
- - [Tabler Icons](https://tabler-icons.io/)
17
- - [Akar Icons](https://akaricons.com/)
18
-
19
- Got suggestions for additional iconsets? Create an issue and we can consider adding them!
20
-
21
- ## Supported Versions
22
-
23
- | Angular Version | Ng Icon Version |
24
- | --------------- | ------------------ |
25
- | 11.x.x | 12.x.x |
26
- | 12.x.x | 13.x.x (or 12.x.x) |
27
- | 13.x.x | 13.x.x |
28
-
29
- > Note: Ng Icons relies on modern browser features and is designed to work on evergreen browsers. We do not support older browsers such as IE11.
30
-
31
- ## Installation
32
-
33
- Ng Icons consists of multiple packages:
34
-
35
- - `@ng-icons/core` - This contains the icon component and the `NgIconsModule` that is used to register the icons you want to include in your application.
36
- - `@ng-icons/bootstrap-icons` - The Bootstrap iconset including both outline and solid variants.
37
- - `@ng-icons/heroicons` - The Heroicons iconset including both outline and solid variants.
38
- - `@ng-icons/ionicons` - The Ionicons iconset including both outline and solid variants.
39
- - `@ng-icons/css.gg` - The CSS.gg iconset.
40
- - `@ng-icons/feather-icons` - The Feather Icons iconset.
41
- - `@ng-icons/jam-icons` - The Jam Icons iconset.
42
- - `@ng-icons/octicons` - The Octicons iconset.
43
- - `@ng-icons/radix-icons` - The Radix UI iconset.
44
- - `@ng-icons/tabler-icons` - The Tabler iconset.
45
- - `@ng-icons/akar-icons` - The Akar iconset.
46
-
47
- You must install the `@ng-icons/core` package, however you only need to install the iconset libraries you intend to use.
48
-
49
- E.g:
50
-
51
- ```bash
52
- npm i @ng-icons/core @ng-icons/heroicons ...
53
- ```
54
-
55
- or
56
-
57
- ```bash
58
- yarn add @ng-icons/core @ng-icons/heroicons ...
59
- ```
60
-
61
- ## Usage
62
-
63
- Import the `NgIconsModule` and register the icons you wish to use:
64
-
65
- ```ts
66
- import { NgIconsModule } from '@ng-icons/core';
67
- import { FeatherAirplay } from '@ng-icons/feather-icons';
68
- import { HeroUsers } from '@ng-icons/heroicons';
69
-
70
- @NgModule({
71
- imports: [
72
- BrowserModule,
73
- NgIconsModule.withIcons({ FeatherAirplay, HeroUsers }),
74
- ],
75
- })
76
- export class AppModule {}
77
- ```
78
-
79
- You can register icons in multiple modules, this allows icons to be lazy loaded in child modules.
80
-
81
- You can then use the icon in your templates:
82
-
83
- ```html
84
- <ng-icon name="feather-airplay"></ng-icon>
85
- ```
86
-
87
- | Name | Type | Description |
88
- | ----------- | ---------------- | ------------------------------------ |
89
- | size | string | Define the size of the icon. |
90
- | strokeWidth | string \| number | Define the stroke-width of the icon. |
1
+
2
+ <img width="847" alt="logo" src="https://user-images.githubusercontent.com/20795331/142078474-da890691-b524-4144-9640-2f7f9da3a3a3.png">
3
+
4
+ # Ng Icons
5
+
6
+ The all-in-one icon library for Angular. This allows you to use icons from multiple icon sets with a single icon component.
7
+ Containing over 17000+ icons for you to use in your projects.
8
+
9
+ Currently, we support the following libraries:
10
+
11
+ - [Bootstrap Icons](https://icons.getbootstrap.com/)
12
+ - [Heroicons](https://heroicons.com/)
13
+ - [Ionicons](https://ionic.io/ionicons)
14
+ - [Material Icons](https://fonts.google.com/icons?selected=Material+Icons)
15
+ - [CSS.gg](https://css.gg/)
16
+ - [Feather Icons](https://feathericons.com/)
17
+ - [Jam Icons](https://jam-icons.com/)
18
+ - [Octicons](https://github.com/primer/octicons)
19
+ - [Radix UI Icons](https://icons.modulz.app/)
20
+ - [Tabler Icons](https://tabler-icons.io/)
21
+ - [Akar Icons](https://akaricons.com/)
22
+
23
+ Got suggestions for additional iconsets? Create an issue and we can consider adding them!
24
+
25
+ ## Supported Versions
26
+
27
+ | Angular Version | Ng Icon Version |
28
+ | --------------- | ------------------ |
29
+ | 11.x.x | 12.x.x |
30
+ | 12.x.x | 13.x.x (or 12.x.x) |
31
+ | 13.x.x | 13.x.x |
32
+
33
+ > Note: Ng Icons relies on modern browser features and is designed to work on evergreen browsers. We do not support older browsers such as IE11.
34
+
35
+ ## Installation
36
+
37
+ You must install the `@ng-icons/core` package, however you only need to install the iconset libraries you intend to use.
38
+
39
+ E.g:
40
+
41
+ ```bash
42
+ npm i @ng-icons/core @ng-icons/heroicons ...
43
+ ```
44
+
45
+ or
46
+
47
+ ```bash
48
+ yarn add @ng-icons/core @ng-icons/heroicons ...
49
+ ```
50
+
51
+ ## Packages
52
+
53
+ The following packages are available:
54
+
55
+ | Package | License |
56
+ | --------------------------- | ---------- |
57
+ | `@ng-icons/core` | MIT |
58
+ | `@ng-icons/bootstrap-icons` | MIT |
59
+ | `@ng-icons/heroicons` | MIT |
60
+ | `@ng-icons/ionicons` | MIT |
61
+ | `@ng-icons/material-icons` | Apache 2.0 |
62
+ | `@ng-icons/css.gg` | MIT |
63
+ | `@ng-icons/feather-icons` | MIT |
64
+ | `@ng-icons/jam-icons` | MIT |
65
+ | `@ng-icons/octicons` | MIT |
66
+ | `@ng-icons/radix-icons` | MIT |
67
+ | `@ng-icons/tabler-icons` | MIT |
68
+ | `@ng-icons/akar-icons` | MIT |
69
+
70
+ ## Usage
71
+
72
+ Import the `NgIconsModule` and register the icons you wish to use:
73
+
74
+ ```ts
75
+ import { NgIconsModule } from '@ng-icons/core';
76
+ import { FeatherAirplay } from '@ng-icons/feather-icons';
77
+ import { HeroUsers } from '@ng-icons/heroicons';
78
+
79
+ @NgModule({
80
+ imports: [
81
+ BrowserModule,
82
+ NgIconsModule.withIcons({ FeatherAirplay, HeroUsers }),
83
+ ],
84
+ })
85
+ export class AppModule {}
86
+ ```
87
+
88
+ You can register icons in multiple modules, this allows icons to be lazy loaded in child modules.
89
+
90
+ You can then use the icon in your templates:
91
+
92
+ ```html
93
+ <ng-icon name="feather-airplay"></ng-icon>
94
+ ```
95
+
96
+ | Name | Type | Description |
97
+ | ----------- | -------------------- | ---------------------------------------------------------------------------------- |
98
+ | size | `string` | Define the size of the icon. This defaults to the current font size. |
99
+ | color | `string` | Define the color of the icon. This defaults to the current text color. |
100
+ | strokeWidth | `string` \| `number` | Define the stroke-width of the icon. This only works on iconsets that use strokes. |