atum-icons 1.0.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 +102 -0
- package/dist/bundle.js +1 -0
- package/package.json +28 -0
package/README.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# React Icon Library - atum-icons
|
|
2
|
+
|
|
3
|
+
A highly customizable React icon library featuring multiple visual styles, including **linear**, **outline**, **bold**, **broken**, **bulk**, and **twotone**. This library makes it easy to integrate SVG icons into your React projects with various styles to suit your design needs.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
To install the library, use either npm or yarn:
|
|
10
|
+
|
|
11
|
+
### Using npm:
|
|
12
|
+
```bash
|
|
13
|
+
npm install atum-icons
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Using yarn:
|
|
17
|
+
```bash
|
|
18
|
+
yarn add atum-icons
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Quickstart
|
|
24
|
+
|
|
25
|
+
After installing the package, you can import and use the icons in your React components with different variants.
|
|
26
|
+
|
|
27
|
+
### Example Usage:
|
|
28
|
+
```javascript
|
|
29
|
+
import React from 'react';
|
|
30
|
+
import { Icon } from 'atum-icons';
|
|
31
|
+
|
|
32
|
+
const App = () => (
|
|
33
|
+
<div>
|
|
34
|
+
<h1>React Icon Library - atum-icons</h1>
|
|
35
|
+
<Icon name="home" variant="linear" size={48} color="blue" />
|
|
36
|
+
<Icon name="home" variant="outline" size={48} color="red" />
|
|
37
|
+
<Icon name="home" variant="bold" size={48} color="green" />
|
|
38
|
+
<Icon name="home" variant="twotone" size={48} color="#FFA500" />
|
|
39
|
+
</div>
|
|
40
|
+
);
|
|
41
|
+
|
|
42
|
+
export default App;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## How to Use
|
|
48
|
+
|
|
49
|
+
1. **Import the Icon component:**
|
|
50
|
+
```javascript
|
|
51
|
+
import { Icon } from 'atum-icons';
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
2. **Choose the icon by name:**
|
|
55
|
+
The name should match the SVG file name, e.g., `home`, `user`, etc.
|
|
56
|
+
|
|
57
|
+
3. **Select the icon variant:**
|
|
58
|
+
Available variants are:
|
|
59
|
+
- `linear` (default)
|
|
60
|
+
- `outline`
|
|
61
|
+
- `bold`
|
|
62
|
+
- `broken`
|
|
63
|
+
- `bulk`
|
|
64
|
+
- `twotone`
|
|
65
|
+
|
|
66
|
+
4. **Customize the icon’s size and color:**
|
|
67
|
+
You can customize the size (default is 24px) and color (default is `currentColor`) by passing them as props.
|
|
68
|
+
|
|
69
|
+
Example:
|
|
70
|
+
```javascript
|
|
71
|
+
<Icon name="home" variant="linear" size={48} color="blue" />
|
|
72
|
+
<Icon name="user" variant="outline" size={48} color="red" />
|
|
73
|
+
<Icon name="settings" variant="bold" size={36} color="green" />
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Supported Variants
|
|
79
|
+
|
|
80
|
+
- `linear` (default)
|
|
81
|
+
- `outline`
|
|
82
|
+
- `bold`
|
|
83
|
+
- `broken`
|
|
84
|
+
- `bulk`
|
|
85
|
+
- `twotone`
|
|
86
|
+
|
|
87
|
+
Ensure that your icon set contains corresponding SVG files for each variant.
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## License
|
|
92
|
+
|
|
93
|
+
This library is open source and available under the **MIT License**.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
## Queries
|
|
98
|
+
|
|
99
|
+
For any queries or issues, feel free to reach out:
|
|
100
|
+
|
|
101
|
+
- Email: [fullstackdevnithish@gmail.com](mailto:fullstackdevnithish@gmail.com)
|
|
102
|
+
- LinkedIn: [Nithishkumar Thiruselvam](https://www.linkedin.com/in/fullstackdevnithishatum/)
|
package/dist/bundle.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("react")):"function"==typeof define&&define.amd?define(["react"],t):"object"==typeof exports?exports.myIconLibrary=t(require("react")):e.myIconLibrary=t(e.react)}(self,(e=>(()=>{var t={915:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>a});var n,o=r(155);function c(){return c=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},c.apply(null,arguments)}const a=function(e){return o.createElement("svg",c({xmlns:"http://www.w3.org/2000/svg",width:24,height:24,fill:"none"},e),n||(n=o.createElement("path",{fill:"#171717",d:"M21.07 5.23c-1.61-.16-3.22-.28-4.84-.37v-.01l-.22-1.3c-.15-.92-.37-2.3-2.71-2.3h-2.62c-2.33 0-2.55 1.32-2.71 2.29l-.21 1.28c-.93.06-1.86.12-2.79.21l-2.04.2c-.42.04-.72.41-.68.82s.4.71.82.67l2.04-.2c5.24-.52 10.52-.32 15.82.21h.08c.38 0 .71-.29.75-.68a.766.766 0 0 0-.69-.82M19.23 8.14c-.24-.25-.57-.39-.91-.39H5.68c-.34 0-.68.14-.91.39s-.36.59-.34.94l.62 10.26c.11 1.52.25 3.42 3.74 3.42h6.42c3.49 0 3.63-1.89 3.74-3.42l.62-10.25c.02-.36-.11-.7-.34-.95m-5.57 9.61h-3.33c-.41 0-.75-.34-.75-.75s.34-.75.75-.75h3.33c.41 0 .75.34.75.75s-.34.75-.75.75m.84-4h-5c-.41 0-.75-.34-.75-.75s.34-.75.75-.75h5c.41 0 .75.34.75.75s-.34.75-.75.75"})))}},61:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>a});var n,o=r(155);function c(){return c=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},c.apply(null,arguments)}const a=function(e){return o.createElement("svg",c({xmlns:"http://www.w3.org/2000/svg",width:24,height:24,fill:"none"},e),n||(n=o.createElement("path",{stroke:"#171717",strokeLinecap:"round",strokeLinejoin:"round",strokeWidth:1.5,d:"M21 5.98c-3.33-.33-6.68-.5-10.02-.5q-2.97 0-5.94.3L3 5.98M8.5 4.97l.22-1.31C8.88 2.71 9 2 10.69 2h2.62c1.69 0 1.82.75 1.97 1.67l.22 1.3M15.21 22H8.79C6 22 5.91 20.78 5.8 19.21L5.15 9.14M18.85 9.14l-.65 10.07M10.33 16.5h3.33M12.82 12.5h1.68M9.5 12.5h.83"})))}},598:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>i});var n,o,c,a=r(155);function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},l.apply(null,arguments)}const i=function(e){return a.createElement("svg",l({xmlns:"http://www.w3.org/2000/svg",width:24,height:24,fill:"none"},e),n||(n=a.createElement("path",{fill:"#171717",d:"M21.07 5.23c-1.61-.16-3.22-.28-4.84-.37v-.01l-.22-1.3c-.15-.92-.37-2.3-2.71-2.3h-2.62c-2.33 0-2.55 1.32-2.71 2.29l-.21 1.28c-.93.06-1.86.12-2.79.21l-2.04.2c-.42.04-.72.41-.68.82s.4.71.82.67l2.04-.2c5.24-.52 10.52-.32 15.82.21h.08c.38 0 .71-.29.75-.68a.766.766 0 0 0-.69-.82"})),o||(o=a.createElement("path",{fill:"#171717",d:"M19.23 8.14c-.24-.25-.57-.39-.91-.39H5.68c-.34 0-.68.14-.91.39s-.36.59-.34.94l.62 10.26c.11 1.52.25 3.42 3.74 3.42h6.42c3.49 0 3.63-1.89 3.74-3.42l.62-10.25c.02-.36-.11-.7-.34-.95",opacity:.399})),c||(c=a.createElement("path",{fill:"#171717",fillRule:"evenodd",d:"M9.58 17a.75.75 0 0 1 .75-.75h3.33a.75.75 0 0 1 0 1.5h-3.33a.75.75 0 0 1-.75-.75M8.75 13a.75.75 0 0 1 .75-.75h5a.75.75 0 0 1 0 1.5h-5a.75.75 0 0 1-.75-.75",clipRule:"evenodd"})))}},493:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>a});var n,o=r(155);function c(){return c=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},c.apply(null,arguments)}const a=function(e){return o.createElement("svg",c({xmlns:"http://www.w3.org/2000/svg",width:24,height:24,fill:"none"},e),n||(n=o.createElement("path",{stroke:"#171717",strokeLinecap:"round",strokeLinejoin:"round",strokeWidth:1.5,d:"M21 5.98c-3.33-.33-6.68-.5-10.02-.5q-2.97 0-5.94.3L3 5.98M8.5 4.97l.22-1.31C8.88 2.71 9 2 10.69 2h2.62c1.69 0 1.82.75 1.97 1.67l.22 1.3M18.85 9.14l-.65 10.07C18.09 20.78 18 22 15.21 22H8.79C6 22 5.91 20.78 5.8 19.21L5.15 9.14M10.33 16.5h3.33M9.5 12.5h5"})))}},952:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>i});var n,o,c,a=r(155);function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},l.apply(null,arguments)}const i=function(e){return a.createElement("svg",l({xmlns:"http://www.w3.org/2000/svg",width:24,height:24,fill:"none"},e),n||(n=a.createElement("path",{fill:"#171717",d:"M21 6.73h-.08c-5.29-.53-10.57-.73-15.8-.2l-2.04.2a.755.755 0 0 1-.83-.68c-.04-.42.26-.78.67-.82l2.04-.2c5.32-.54 10.71-.33 16.11.2.41.04.71.41.67.82a.74.74 0 0 1-.74.68"})),o||(o=a.createElement("path",{fill:"#171717",d:"M8.5 5.72c-.04 0-.08 0-.13-.01a.753.753 0 0 1-.61-.86l.22-1.31c.16-.96.38-2.29 2.71-2.29h2.62c2.34 0 2.56 1.38 2.71 2.3l.22 1.3c.07.41-.21.8-.61.86-.41.07-.8-.21-.86-.61l-.22-1.3c-.14-.87-.17-1.04-1.23-1.04H10.7c-1.06 0-1.08.14-1.23 1.03l-.23 1.3a.75.75 0 0 1-.74.63M15.21 22.75H8.79c-3.49 0-3.63-1.93-3.74-3.49L4.4 9.19c-.03-.41.29-.77.7-.8.42-.02.77.29.8.7l.65 10.07c.11 1.52.15 2.09 2.24 2.09h6.42c2.1 0 2.14-.57 2.24-2.09l.65-10.07c.03-.41.39-.72.8-.7.41.03.73.38.7.8l-.65 10.07c-.11 1.56-.25 3.49-3.74 3.49"})),c||(c=a.createElement("path",{fill:"#171717",d:"M13.66 17.25h-3.33c-.41 0-.75-.34-.75-.75s.34-.75.75-.75h3.33c.41 0 .75.34.75.75s-.34.75-.75.75M14.5 13.25h-5c-.41 0-.75-.34-.75-.75s.34-.75.75-.75h5c.41 0 .75.34.75.75s-.34.75-.75.75"})))}},700:(e,t,r)=>{"use strict";r.r(t),r.d(t,{default:()=>s});var n,o,c,a,l=r(155);function i(){return i=Object.assign?Object.assign.bind():function(e){for(var t=1;t<arguments.length;t++){var r=arguments[t];for(var n in r)({}).hasOwnProperty.call(r,n)&&(e[n]=r[n])}return e},i.apply(null,arguments)}const s=function(e){return l.createElement("svg",i({xmlns:"http://www.w3.org/2000/svg",width:24,height:24,fill:"none"},e),n||(n=l.createElement("path",{stroke:"#171717",strokeLinecap:"round",strokeLinejoin:"round",strokeWidth:1.5,d:"M21 5.98c-3.33-.33-6.68-.5-10.02-.5q-2.97 0-5.94.3L3 5.98"})),o||(o=l.createElement("path",{stroke:"#171717",strokeLinecap:"round",strokeLinejoin:"round",strokeWidth:1.5,d:"m8.5 4.97.22-1.31C8.88 2.71 9 2 10.69 2h2.62c1.69 0 1.82.75 1.97 1.67l.22 1.3",opacity:.34})),c||(c=l.createElement("path",{stroke:"#171717",strokeLinecap:"round",strokeLinejoin:"round",strokeWidth:1.5,d:"m18.85 9.14-.65 10.07C18.09 20.78 18 22 15.21 22H8.79C6 22 5.91 20.78 5.8 19.21L5.15 9.14"})),a||(a=l.createElement("path",{stroke:"#171717",strokeLinecap:"round",strokeLinejoin:"round",strokeWidth:1.5,d:"M10.33 16.5h3.33M9.5 12.5h5",opacity:.34})))}},673:(e,t,r)=>{var n={"./Trashcan-bold.svg":915,"./Trashcan-broken.svg":61,"./Trashcan-bulk.svg":598,"./Trashcan-linear.svg":493,"./Trashcan-outine.svg":952,"./Trashcan-twotone.svg":700};function o(e){var t=c(e);return r(t)}function c(e){if(!r.o(n,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return n[e]}o.keys=function(){return Object.keys(n)},o.resolve=c,e.exports=o,o.id=673},155:t=>{"use strict";t.exports=e}},r={};function n(e){var o=r[e];if(void 0!==o)return o.exports;var c=r[e]={exports:{}};return t[e](c,c.exports,n),c.exports}n.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return n.d(t,{a:t}),t},n.d=(e,t)=>{for(var r in t)n.o(t,r)&&!n.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},n.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var o={};return(()=>{"use strict";n.r(o),n.d(o,{Icon:()=>c});var e=n(155),t=n.n(e),r=n(673);const c=function(e){var n,o=e.name,c=e.variant,a=void 0===c?"linear":c,l=e.size,i=void 0===l?24:l,s=e.color,u=void 0===s?"currentColor":s,h="".concat(o,"-").concat(a);try{n=r("./".concat(h,".svg")).default}catch(e){console.warn('Icon "'.concat(h,'" not found. Defaulting to linear.'));try{n=r("./".concat(o,"-linear.svg")).default}catch(e){return console.error('Icon "'.concat(o,'" not found at all.')),null}}return t().createElement(n,{width:i,height:i,fill:u})}})(),o})()));
|
package/package.json
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "atum-icons",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"main": "dist/bundle.js",
|
|
5
|
+
"module": "dist/bundle.js",
|
|
6
|
+
"files": ["dist"],
|
|
7
|
+
"scripts": {
|
|
8
|
+
"test": "echo \"Error: no test specified\" && exit 1",
|
|
9
|
+
"build": "webpack"
|
|
10
|
+
},
|
|
11
|
+
"keywords": [],
|
|
12
|
+
"author": "",
|
|
13
|
+
"license": "ISC",
|
|
14
|
+
"description": "",
|
|
15
|
+
"dependencies": {
|
|
16
|
+
"react": "^19.0.0",
|
|
17
|
+
"react-dom": "^19.0.0"
|
|
18
|
+
},
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"@babel/core": "^7.26.0",
|
|
21
|
+
"@babel/preset-env": "^7.26.0",
|
|
22
|
+
"@babel/preset-react": "^7.26.3",
|
|
23
|
+
"@svgr/webpack": "^8.1.0",
|
|
24
|
+
"babel-loader": "^9.2.1",
|
|
25
|
+
"webpack": "^5.97.1",
|
|
26
|
+
"webpack-cli": "^5.1.4"
|
|
27
|
+
}
|
|
28
|
+
}
|