@bigbinary/neeto-icons 1.20.89 → 1.21.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 +14 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# neetoIcons
|
|
2
2
|
|
|
3
|
-
The neetoIcons and neetoIconsRN library are a collection of SVG React component icons that drives
|
|
4
|
-
|
|
3
|
+
The neetoIcons and neetoIconsRN library are a collection of SVG React component icons that drives the experience in the
|
|
4
|
+
neeto products built at BigBinary.
|
|
5
5
|
|
|
6
6
|
## Contents
|
|
7
7
|
|
|
@@ -26,12 +26,13 @@ yarn add @bigbinary/neeto-icons-rn
|
|
|
26
26
|
|
|
27
27
|
### Instructions for development
|
|
28
28
|
|
|
29
|
-
Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step
|
|
29
|
+
Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step
|
|
30
|
+
instructions to develop the frontend package.
|
|
30
31
|
|
|
31
32
|
#### Adding a new icon to the library
|
|
32
33
|
|
|
33
|
-
1. **Add the SVG file -**
|
|
34
|
-
|
|
34
|
+
1. **Add the SVG file -** Place the SVG file for the new icon in the appropriate folder under the `source` directory.
|
|
35
|
+
For example:
|
|
35
36
|
- `icons/` for normal icons
|
|
36
37
|
- `logos/` for product logos
|
|
37
38
|
- `typefaceLogos/` for product typeface logos
|
|
@@ -39,11 +40,9 @@ Check the [Frontend package development guide](https://neeto-engineering.neetokb
|
|
|
39
40
|
- `misc/` for miscellaneous icons
|
|
40
41
|
- `elements/` for elements
|
|
41
42
|
|
|
42
|
-
2. **Name the file appropriately -**
|
|
43
|
-
Use PascalCase for the file name (e.g., `NewIcon.svg`).
|
|
43
|
+
2. **Name the file appropriately -** Use PascalCase for the file name (e.g., `NewIcon.svg`).
|
|
44
44
|
|
|
45
|
-
3. **Verify the icon -**
|
|
46
|
-
Run the `yarn start` command to verify the React component for the new icon:
|
|
45
|
+
3. **Verify the icon -** Run the `yarn start` command to verify the React component for the new icon:
|
|
47
46
|
|
|
48
47
|
### Usage
|
|
49
48
|
|
|
@@ -152,11 +151,9 @@ Anywhere in your React file
|
|
|
152
151
|
|
|
153
152
|
## How it works
|
|
154
153
|
|
|
155
|
-
- We use a custom rollup plugin (which can be found in `build/index.mjs`) to
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
- The plugin accepts a configuration object as an argument which can contain the
|
|
159
|
-
following keys:
|
|
154
|
+
- We use a custom rollup plugin (which can be found in `build/index.mjs`) to take all the `.svg` files from the `source`
|
|
155
|
+
folder and convert them to React components that render the respective SVG icon.
|
|
156
|
+
- The plugin accepts a configuration object as an argument which can contain the following keys:
|
|
160
157
|
|
|
161
158
|
| Name | Type | Description |
|
|
162
159
|
| ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
@@ -170,4 +167,6 @@ Anywhere in your React file
|
|
|
170
167
|
|
|
171
168
|
## Instructions for Publishing
|
|
172
169
|
|
|
173
|
-
Consult the
|
|
170
|
+
Consult the
|
|
171
|
+
[building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide
|
|
172
|
+
for details on how to publish.
|