@2hoch1/pixel-icon-library-react 1.0.0 → 1.0.2
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/LICENSE +25 -0
- package/README.md +14 -8
- package/package.json +11 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 2hoch1
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
23
|
+
Note: Icon assets and original designs are credited to HackerNoon and the
|
|
24
|
+
Pixel Icon Library project. This package is a React wrapper fork published
|
|
25
|
+
under the @2hoch1 scope.
|
package/README.md
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @2hoch1/pixel-icon-library-react
|
|
2
2
|
|
|
3
3
|
React components for [Pixel Icon Library](https://pixeliconlibrary.com) - pixelated icons that you can easily import as React components, just like [lucide-react](https://lucide.dev).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @
|
|
8
|
+
npm install @2hoch1/pixel-icon-library-react react
|
|
9
9
|
# or
|
|
10
|
-
yarn add @
|
|
10
|
+
yarn add @2hoch1/pixel-icon-library-react react
|
|
11
11
|
# or
|
|
12
|
-
pnpm add @
|
|
12
|
+
pnpm add @2hoch1/pixel-icon-library-react react
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
17
|
```tsx
|
|
18
18
|
import React from 'react';
|
|
19
|
-
import { AlertTriangle, RotateCw, Home, AlertTriangleSolid, HomeBrands } from '@
|
|
19
|
+
import { AlertTriangle, RotateCw, Home, AlertTriangleSolid, HomeBrands } from '@2hoch1/pixel-icon-library-react';
|
|
20
20
|
|
|
21
21
|
export function MyComponent() {
|
|
22
22
|
return (
|
|
@@ -94,7 +94,7 @@ Browse all available icons at [pixeliconlibrary.com](https://pixeliconlibrary.co
|
|
|
94
94
|
### With Tailwind CSS
|
|
95
95
|
|
|
96
96
|
```tsx
|
|
97
|
-
import { Home, Settings, Users } from '@
|
|
97
|
+
import { Home, Settings, Users } from '@2hoch1/pixel-icon-library-react';
|
|
98
98
|
|
|
99
99
|
export function Navigation() {
|
|
100
100
|
return (
|
|
@@ -111,7 +111,7 @@ export function Navigation() {
|
|
|
111
111
|
|
|
112
112
|
```tsx
|
|
113
113
|
import styled from 'styled-components';
|
|
114
|
-
import { AlertTriangle } from '@
|
|
114
|
+
import { AlertTriangle } from '@2hoch1/pixel-icon-library-react';
|
|
115
115
|
|
|
116
116
|
const IconWrapper = styled.div`
|
|
117
117
|
display: flex;
|
|
@@ -135,7 +135,7 @@ export function ErrorMessage() {
|
|
|
135
135
|
Full TypeScript support is included out of the box:
|
|
136
136
|
|
|
137
137
|
```tsx
|
|
138
|
-
import type { PixelIcon } from '@
|
|
138
|
+
import type { PixelIcon } from '@2hoch1/pixel-icon-library-react';
|
|
139
139
|
|
|
140
140
|
const iconMap: Record<string, PixelIcon> = {
|
|
141
141
|
home: Home,
|
|
@@ -144,6 +144,12 @@ const iconMap: Record<string, PixelIcon> = {
|
|
|
144
144
|
};
|
|
145
145
|
```
|
|
146
146
|
|
|
147
|
+
## Credits
|
|
148
|
+
|
|
149
|
+
- Icons: Created by [HackerNoon](https://hackernoon.com) — see the original [Pixel Icon Library](https://pixeliconlibrary.com) and [@hackernoon](https://github.com/hackernoon).
|
|
150
|
+
- React wrapper: Published as a fork under `@2hoch1/pixel-icon-library-react`.
|
|
151
|
+
|
|
147
152
|
## License
|
|
148
153
|
|
|
149
154
|
MIT © [HackerNoon](https://hackernoon.com)
|
|
155
|
+
MIT © [2hoch1](https://github.com/2hoch1/pixel-icon-library/tree/main/packages/pixel-icon-library-react)
|
package/package.json
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@2hoch1/pixel-icon-library-react",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "React
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "Forked React wrapper for Pixel Icon Library icons (credits: @hackernoon)",
|
|
5
5
|
"homepage": "https://pixeliconlibrary.com",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "2hoch1"
|
|
8
|
+
},
|
|
9
|
+
"contributors": [
|
|
10
|
+
{
|
|
11
|
+
"name": "HackerNoon",
|
|
12
|
+
"url": "https://github.com/hackernoon"
|
|
13
|
+
}
|
|
14
|
+
],
|
|
6
15
|
"keywords": [
|
|
7
16
|
"hackernoon",
|
|
8
17
|
"pixelated",
|