@ng-icons/heroicons 13.0.0 → 13.1.0
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 +26 -19
- package/esm2020/index.mjs +461 -3
- package/fesm2015/ng-icons-heroicons.mjs +0 -1
- package/fesm2015/ng-icons-heroicons.mjs.map +1 -1
- package/fesm2020/ng-icons-heroicons.mjs +0 -1
- package/fesm2020/ng-icons-heroicons.mjs.map +1 -1
- package/index.d.ts +460 -2
- package/package.json +1 -1
- package/esm2020/outline.mjs +0 -231
- package/esm2020/solid.mjs +0 -231
- package/outline.d.ts +0 -230
- package/solid.d.ts +0 -230
package/README.md
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
# Ng Icons
|
|
2
2
|
|
|
3
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
|
|
4
|
+
Containing over 17000+ icons for you to use in your projects.
|
|
5
5
|
|
|
6
6
|
Currently, we support the following libraries:
|
|
7
7
|
|
|
8
8
|
- [Bootstrap Icons](https://icons.getbootstrap.com/)
|
|
9
9
|
- [Heroicons](https://heroicons.com/)
|
|
10
10
|
- [Ionicons](https://ionic.io/ionicons)
|
|
11
|
+
- [Material Icons](https://fonts.google.com/icons?selected=Material+Icons)
|
|
11
12
|
- [CSS.gg](https://css.gg/)
|
|
12
13
|
- [Feather Icons](https://feathericons.com/)
|
|
13
14
|
- [Jam Icons](https://jam-icons.com/)
|
|
@@ -30,20 +31,6 @@ Got suggestions for additional iconsets? Create an issue and we can consider add
|
|
|
30
31
|
|
|
31
32
|
## Installation
|
|
32
33
|
|
|
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
34
|
You must install the `@ng-icons/core` package, however you only need to install the iconset libraries you intend to use.
|
|
48
35
|
|
|
49
36
|
E.g:
|
|
@@ -58,6 +45,25 @@ or
|
|
|
58
45
|
yarn add @ng-icons/core @ng-icons/heroicons ...
|
|
59
46
|
```
|
|
60
47
|
|
|
48
|
+
## Packages
|
|
49
|
+
|
|
50
|
+
The following packages are available:
|
|
51
|
+
|
|
52
|
+
| Package | License |
|
|
53
|
+
| --------------------------- | ---------- |
|
|
54
|
+
| `@ng-icons/core` | MIT |
|
|
55
|
+
| `@ng-icons/bootstrap-icons` | MIT |
|
|
56
|
+
| `@ng-icons/heroicons` | MIT |
|
|
57
|
+
| `@ng-icons/ionicons` | MIT |
|
|
58
|
+
| `@ng-icons/material-icons` | Apache 2.0 |
|
|
59
|
+
| `@ng-icons/css.gg` | MIT |
|
|
60
|
+
| `@ng-icons/feather-icons` | MIT |
|
|
61
|
+
| `@ng-icons/jam-icons` | MIT |
|
|
62
|
+
| `@ng-icons/octicons` | MIT |
|
|
63
|
+
| `@ng-icons/radix-icons` | MIT |
|
|
64
|
+
| `@ng-icons/tabler-icons` | MIT |
|
|
65
|
+
| `@ng-icons/akar-icons` | MIT |
|
|
66
|
+
|
|
61
67
|
## Usage
|
|
62
68
|
|
|
63
69
|
Import the `NgIconsModule` and register the icons you wish to use:
|
|
@@ -84,7 +90,8 @@ You can then use the icon in your templates:
|
|
|
84
90
|
<ng-icon name="feather-airplay"></ng-icon>
|
|
85
91
|
```
|
|
86
92
|
|
|
87
|
-
| Name | Type
|
|
88
|
-
| ----------- |
|
|
89
|
-
| size | string
|
|
90
|
-
|
|
|
93
|
+
| Name | Type | Description |
|
|
94
|
+
| ----------- | -------------------- | ---------------------------------------------------------------------------------- |
|
|
95
|
+
| size | `string` | Define the size of the icon. This defaults to the current font size. |
|
|
96
|
+
| color | `string` | Define the color of the icon. This defaults to the current text color. |
|
|
97
|
+
| strokeWidth | `string` \| `number` | Define the stroke-width of the icon. This only works on iconsets that use strokes. |
|