@impulse-ui-native/icon 2.0.0 → 2.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 +33 -0
- package/dist/icons/index.js +7571 -7571
- package/dist/icons/wrappers/index.js +5 -5
- package/dist/index.js +7576 -7576
- package/package.json +3 -3
- package/dist/{chunk-2LYPKVWR.js → chunk-JBQT3L3U.js} +7570 -7570
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @impulse-ui-native/icon
|
|
2
|
+
|
|
3
|
+
A React Native SVG icon library with a common renderer and six visual weights.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add @impulse-ui-native/icon react-native-svg
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Main exports
|
|
12
|
+
|
|
13
|
+
- `Icon` normalizes icon size, color, and rendering.
|
|
14
|
+
- Named wrapper icons such as `HeartIcon` select a visual weight through the `variant` prop.
|
|
15
|
+
- Every icon is also exported as a weight-specific component, for example `HeartBoldIcon` and `HeartThinIcon`.
|
|
16
|
+
- Available weights are `bold`, `duotone`, `fill`, `light`, `regular`, and `thin`.
|
|
17
|
+
- `IconProps`, `IconWrapperProps`, `IconVariant`, and `IconStyle` support typed composition.
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```tsx
|
|
22
|
+
import { HeartIcon, Icon } from "@impulse-ui-native/icon";
|
|
23
|
+
|
|
24
|
+
<Icon icon={HeartIcon} variant="duotone" size="large" color="#6d5dfc" />;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
You can also render a named wrapper directly when you want to control the SVG dimensions yourself.
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
<HeartIcon variant="regular" width={24} height={24} fill="#111827" />
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
All icons are available from the package root. Wrapper names use the `{Name}Icon` form; fixed-weight names use `{Name}{Weight}Icon`.
|