@epilot360/icons 0.0.1

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.
Files changed (2) hide show
  1. package/README.md +47 -0
  2. package/package.json +20 -0
package/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # @epilot360/icons
2
+
3
+ Curated set of epilot icons based on [material-symbols](https://www.npmjs.com/package/material-symbols)
4
+
5
+ ```
6
+ yarn add @epilot360/icons
7
+ ```
8
+
9
+
10
+ ## Usage
11
+
12
+ The `@epilot360/icons` package is shipped as an external system module in the 360 portal.
13
+
14
+ You can import any icon as a React component by name:
15
+
16
+ ```tsx
17
+ import { Edit as EditIcon } from '@epilot360/icons'
18
+
19
+ <EditIcon />
20
+ ```
21
+
22
+
23
+ Or use the `<EpilotIcon>` React component:
24
+
25
+ ```tsx
26
+ import { EpilotIcon } from '@epilot360/icons'
27
+
28
+ <EpilotIcon name="edit" />
29
+ ```
30
+
31
+ ## Usage outside 360 portal
32
+
33
+ To avoid bundling the entire `@epilot360/icons` library, you can import the module directly:
34
+
35
+ ```tsx
36
+ import Edit from '@epilot360/icons/react/Edit'
37
+
38
+ <Edit />
39
+ ```
40
+
41
+ Or
42
+
43
+ ```tsx
44
+ import { EpilotIcon } from '@epilot360/icons/react'
45
+
46
+ <EpilotIcon name="edit" />
47
+ ```
package/package.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "@epilot360/icons",
3
+ "version": "0.0.1",
4
+ "author": "epilot GmbH",
5
+ "license": "MIT",
6
+ "scripts": {
7
+ "start": "webpack serve --port 5600",
8
+ "build": "webpack --mode=production",
9
+ "test": "jest --passWithNoTests"
10
+ },
11
+ "main": "index.js",
12
+ "types": "index.d.ts",
13
+ "devDependencies": {
14
+ },
15
+ "dependencies": {
16
+ },
17
+ "peerDependencies": {
18
+ "react": "^17.0.2"
19
+ }
20
+ }