@boxicons/react 1.0.0 → 1.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.
- package/README.md +11 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
# boxicons
|
|
1
|
+
# @boxicons/react
|
|
2
2
|
|
|
3
3
|
React icon library built from Boxicons SVG files with full tree-shaking support.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install boxicons
|
|
8
|
+
npm install @boxicons/react
|
|
9
9
|
# or
|
|
10
|
-
yarn add boxicons
|
|
10
|
+
yarn add @boxicons/react
|
|
11
11
|
# or
|
|
12
|
-
pnpm add boxicons
|
|
12
|
+
pnpm add @boxicons/react
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Usage
|
|
@@ -17,7 +17,7 @@ pnpm add boxicons-react
|
|
|
17
17
|
### Basic Usage
|
|
18
18
|
|
|
19
19
|
```tsx
|
|
20
|
-
import { Alarm, Twitter, Home } from 'boxicons
|
|
20
|
+
import { Alarm, Twitter, Home } from '@boxicons/react';
|
|
21
21
|
|
|
22
22
|
function App() {
|
|
23
23
|
return (
|
|
@@ -39,7 +39,7 @@ Each icon can have multiple variants. Use the `pack` prop to switch between them
|
|
|
39
39
|
- **brands** - Brand/logo icons (default for brand icons like Twitter, Facebook, etc.)
|
|
40
40
|
|
|
41
41
|
```tsx
|
|
42
|
-
import { Alarm } from 'boxicons
|
|
42
|
+
import { Alarm } from '@boxicons/react';
|
|
43
43
|
|
|
44
44
|
function App() {
|
|
45
45
|
return (
|
|
@@ -166,7 +166,7 @@ Refs are forwarded to the SVG element:
|
|
|
166
166
|
|
|
167
167
|
```tsx
|
|
168
168
|
import { useRef } from 'react';
|
|
169
|
-
import { Alarm } from 'boxicons
|
|
169
|
+
import { Alarm } from '@boxicons/react';
|
|
170
170
|
|
|
171
171
|
function App() {
|
|
172
172
|
const iconRef = useRef<SVGSVGElement>(null);
|
|
@@ -181,10 +181,10 @@ This library is fully tree-shakeable. Only the icons you import will be included
|
|
|
181
181
|
|
|
182
182
|
```tsx
|
|
183
183
|
// ✅ Only Alarm is bundled
|
|
184
|
-
import { Alarm } from 'boxicons
|
|
184
|
+
import { Alarm } from '@boxicons/react';
|
|
185
185
|
|
|
186
186
|
// ✅ Direct import also works
|
|
187
|
-
import { Alarm } from 'boxicons
|
|
187
|
+
import { Alarm } from '@boxicons/react/icons/Alarm';
|
|
188
188
|
```
|
|
189
189
|
|
|
190
190
|
## Available Icons
|
|
@@ -214,7 +214,7 @@ Icon names are converted from kebab-case SVG filenames to PascalCase:
|
|
|
214
214
|
Full TypeScript support with exported types:
|
|
215
215
|
|
|
216
216
|
```tsx
|
|
217
|
-
import type { BoxIconProps, IconPack, IconSize, FlipDirection } from 'boxicons
|
|
217
|
+
import type { BoxIconProps, IconPack, IconSize, FlipDirection } from '@boxicons/react';
|
|
218
218
|
```
|
|
219
219
|
|
|
220
220
|
### BoxIconProps
|
|
@@ -234,4 +234,4 @@ interface BoxIconProps extends SVGProps<SVGSVGElement> {
|
|
|
234
234
|
```
|
|
235
235
|
|
|
236
236
|
|
|
237
|
-
# boxicons
|
|
237
|
+
# @boxicons/react
|