@bigbinary/neeto-icons 1.20.89 → 1.21.1

package/README.md

@@ -1,7 +1,7 @@
 # neetoIcons
 
-The neetoIcons and neetoIconsRN library are a collection of SVG React component icons that drives
-the experience in the neeto products built at BigBinary.
+The neetoIcons and neetoIconsRN library are a collection of SVG React component icons that drives the experience in the
+neeto products built at BigBinary.
 
 ## Contents
 
@@ -26,12 +26,13 @@ yarn add @bigbinary/neeto-icons-rn
 
 ### Instructions for development
 
-Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step instructions to develop the frontend package.
+Check the [Frontend package development guide](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) for step-by-step
+instructions to develop the frontend package.
 
 #### Adding a new icon to the library
 
-1. **Add the SVG file -**
-   Place the SVG file for the new icon in the appropriate folder under the `source` directory. For example:
+1. **Add the SVG file -** Place the SVG file for the new icon in the appropriate folder under the `source` directory.
+   For example:
    - `icons/` for normal icons
    - `logos/` for product logos
    - `typefaceLogos/` for product typeface logos
@@ -39,11 +40,9 @@ Check the [Frontend package development guide](https://neeto-engineering.neetokb
    - `misc/` for miscellaneous icons
    - `elements/` for elements
 
-2. **Name the file appropriately -**
-   Use PascalCase for the file name (e.g., `NewIcon.svg`).
+2. **Name the file appropriately -** Use PascalCase for the file name (e.g., `NewIcon.svg`).
 
-3. **Verify the icon -**
-   Run the `yarn start` command to verify the React component for the new icon:
+3. **Verify the icon -** Run the `yarn start` command to verify the React component for the new icon:
 
 ### Usage
 
@@ -65,6 +64,54 @@ Anywhere in your React file
 <Clock color="#1e1e20" size={24} />
 ```
 
+### React Native imports
+
+Every category is available as a barrel:
+
+```javascript
+import { NeetoSite } from "@bigbinary/neeto-icons-rn/app-icons";
+import { Keyboard } from "@bigbinary/neeto-icons-rn/elements";
+import { Clock } from "@bigbinary/neeto-icons-rn/icons";
+import { Neeto } from "@bigbinary/neeto-icons-rn/logos";
+import { Windows } from "@bigbinary/neeto-icons-rn/misc";
+import { Neeto as NeetoTypeface } from "@bigbinary/neeto-icons-rn/typeface-logos";
+```
+
+Each icon can also be imported on its own, as a default export, so that the bundler only pulls in what is used:
+
+```javascript
+import Clock from "@bigbinary/neeto-icons-rn/icons/Clock";
+import Neeto from "@bigbinary/neeto-icons-rn/logos/Neeto";
+```
+
+Every category is also reachable through a single namespaced entry point:
+
+```javascript
+import { Icons, Logos, Misc } from "@bigbinary/neeto-icons-rn/namespaces";
+
+<Icons.Clock size={24} />;
+```
+
+The props type is exported separately:
+
+```typescript
+import type { IconProps } from "@bigbinary/neeto-icons-rn/types";
+```
+
+#### Metro configuration
+
+These subpaths are declared through the `exports` field of the package, which Metro honours by default only from React
+Native 0.79 onward. On earlier versions the field is ignored and the imports above fail to resolve, so enable it in
+`metro.config.js`:
+
+```javascript
+module.exports = {
+  resolver: {
+    unstable_enablePackageExports: true,
+  },
+};
+```
+
 ### Product logos
 
 ```javascript
@@ -152,11 +199,9 @@ Anywhere in your React file
 
 ## How it works
 
-- We use a custom rollup plugin (which can be found in `build/index.mjs`) to
-  take all the `.svg` files from the `source` folder and convert them to React
-  components that render the respective SVG icon.
-- The plugin accepts a configuration object as an argument which can contain the
-  following keys:
+- We use a custom rollup plugin (which can be found in `build/index.mjs`) to take all the `.svg` files from the `source`
+  folder and convert them to React components that render the respective SVG icon.
+- The plugin accepts a configuration object as an argument which can contain the following keys:
 
   | Name                    | Type       | Description                                                                                                              |
   | ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------ |
@@ -170,4 +215,6 @@ Anywhere in your React file
 
 ## Instructions for Publishing
 
-Consult the [building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide for details on how to publish.
+Consult the
+[building and releasing packages](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) guide
+for details on how to publish.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-icons",
-  "version": "1.20.89",
+  "version": "1.21.1",
   "author": "vinay0x",
   "license": "MIT",
   "types": "./icons.d.ts",