@siemens/ix-icons 1.2.0 β 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +6 -31
- package/dist/cjs/icon-a15a0683.js +1487 -0
- package/dist/cjs/icon-a15a0683.js.map +1 -0
- package/dist/cjs/index.cjs.js +1 -1
- package/dist/cjs/ix-icon.cjs.entry.js +1 -1
- package/dist/collection/components/icon/icon.css +17 -2780
- package/dist/collection/components/icon/icon.js +10 -21
- package/dist/collection/components/icon/icon.js.map +1 -1
- package/dist/collection/components/icon/icons.js +679 -0
- package/dist/collection/components/icon/icons.js.map +1 -0
- package/dist/collection/components/icon/resolveIcon.js +27 -3
- package/dist/collection/components/icon/resolveIcon.js.map +1 -1
- package/dist/components/icon.js +1387 -25
- package/dist/components/icon.js.map +1 -1
- package/dist/css/ix-icons.css +13 -719
- package/dist/esm/icon-95eef87f.js +1485 -0
- package/dist/esm/icon-95eef87f.js.map +1 -0
- package/dist/esm/index.js +1 -1
- package/dist/esm/ix-icon.entry.js +1 -1
- package/dist/ix-icons/index.esm.js +1 -1
- package/dist/ix-icons/ix-icons.esm.js +1 -1
- package/dist/ix-icons/p-58a6be66.js +2 -0
- package/dist/ix-icons/p-58a6be66.js.map +1 -0
- package/dist/ix-icons/p-e0e04303.entry.js +2 -0
- package/dist/sample.json +676 -1351
- package/dist/svg/missing-symbol.svg +1 -0
- package/dist/types/components/icon/icon.d.ts +2 -1
- package/dist/types/components/icon/icons.d.ts +677 -0
- package/dist/types/components.d.ts +4 -2
- package/icons/index.d.ts +678 -676
- package/icons/index.js +678 -676
- package/icons/index.mjs +678 -676
- package/icons/package.json +1 -1
- package/package.json +2 -5
- package/dist/cjs/icon-f93d1754.js +0 -125
- package/dist/cjs/icon-f93d1754.js.map +0 -1
- package/dist/collection/components/icon/question.js +0 -5
- package/dist/collection/components/icon/question.js.map +0 -1
- package/dist/esm/icon-6a9c5e3a.js +0 -123
- package/dist/esm/icon-6a9c5e3a.js.map +0 -1
- package/dist/fonts/ix-icons.eot +0 -0
- package/dist/fonts/ix-icons.svg +0 -2037
- package/dist/fonts/ix-icons.ttf +0 -0
- package/dist/fonts/ix-icons.woff +0 -0
- package/dist/fonts/ix-icons.woff2 +0 -0
- package/dist/ix-icons/p-3f1bfdd7.js +0 -2
- package/dist/ix-icons/p-3f1bfdd7.js.map +0 -1
- package/dist/ix-icons/p-56e47578.entry.js +0 -2
- package/dist/sample.html +0 -11645
- package/dist/types/components/icon/question.d.ts +0 -1
- /package/dist/ix-icons/{p-56e47578.entry.js.map β p-e0e04303.entry.js.map} +0 -0
package/README.md
CHANGED
|
@@ -13,8 +13,6 @@ SPDX-License-Identifier: MIT
|
|
|
13
13
|
|
|
14
14
|
[](./LICENSE.md)
|
|
15
15
|
|
|
16
|
-
Icon web font library for `@siemens/ix`
|
|
17
|
-
|
|
18
16
|
## Usage
|
|
19
17
|
|
|
20
18
|
Using icons within your project. You need to:
|
|
@@ -22,17 +20,6 @@ Using icons within your project. You need to:
|
|
|
22
20
|
- Install `@siemens/ix-icons` e.g. `npm install --save @siemens/ix-icons`
|
|
23
21
|
- Load styling e.g. `@siemens/ix-icons/dist/scss/ix-icons.css`
|
|
24
22
|
|
|
25
|
-
```scss
|
|
26
|
-
@import '@siemens/ix-icons/dist/scss/ix-icons.css';
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Usage without `@siemens/ix`
|
|
30
|
-
|
|
31
|
-
Using icons within your project. You need to:
|
|
32
|
-
|
|
33
|
-
- Install `@siemens/ix-icons` e.g. `npm install --save @siemens/ix-icons`
|
|
34
|
-
- Load styling e.g. `@siemens/ix-icons/dist/scss/ix-icons.css`
|
|
35
|
-
|
|
36
23
|
```javascript
|
|
37
24
|
import { defineCustomElements } from '@siemens/ix-icons/loader';
|
|
38
25
|
|
|
@@ -43,16 +30,6 @@ import { defineCustomElements } from '@siemens/ix-icons/loader';
|
|
|
43
30
|
|
|
44
31
|
### Use icon via string name
|
|
45
32
|
|
|
46
|
-
In this case the `ix-icon` component is using the web font. Which requires the import of the css file in some of your style files:
|
|
47
|
-
|
|
48
|
-
`styles.css`
|
|
49
|
-
|
|
50
|
-
```scss
|
|
51
|
-
@import '@siemens/ix-icons/dist/scss/ix-icons.css';
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
`demo.html`
|
|
55
|
-
|
|
56
33
|
```html
|
|
57
34
|
<ix-icon name="rocket"></ix-icon>
|
|
58
35
|
```
|
|
@@ -62,10 +39,15 @@ In this case the `ix-icon` component is using the web font. Which requires the i
|
|
|
62
39
|
```tsx
|
|
63
40
|
import { rocket } from '@siemens/ix-icons/icons';
|
|
64
41
|
|
|
65
|
-
// render your template code
|
|
66
42
|
<ix-icon name={rocket}></ix-icon>;
|
|
67
43
|
```
|
|
68
44
|
|
|
45
|
+
### Use `ix-icon` component with custom svg's
|
|
46
|
+
|
|
47
|
+
```tsx
|
|
48
|
+
<ix-icon name="/your/asset/path/my-icon.svg"></ix-icon>;
|
|
49
|
+
```
|
|
50
|
+
|
|
69
51
|
## Development
|
|
70
52
|
|
|
71
53
|
### Installation
|
|
@@ -84,13 +66,6 @@ yarn build
|
|
|
84
66
|
|
|
85
67
|
Contributions, issues and feature requests are welcome!
|
|
86
68
|
|
|
87
|
-
## π¨βπ» Contributors
|
|
88
|
-
|
|
89
|
-
- Daniel Leroux <daniel.leroux@siemens.com>
|
|
90
|
-
- Lukas Maurer <lukas.maurer@siemens.com>
|
|
91
|
-
- Carlos Leandro Cruz Ferrer <carlos.cruz_ferrer@siemens.com>
|
|
92
|
-
- Gonçalo Ferreira <goncalo.alves-ferreira@siemens.com>
|
|
93
|
-
|
|
94
69
|
## π License
|
|
95
70
|
|
|
96
71
|
Copyright Β© 2019β2023 [Siemens AG](https://www.siemens.com/).
|