@vellira-ui/icons 2.53.0 → 2.55.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 +61 -7
- package/package.json +15 -1
package/README.md
CHANGED
|
@@ -2,7 +2,52 @@
|
|
|
2
2
|
|
|
3
3
|
Shared icon package for Vellira.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Provides static icons for React and React Native together with animated icon
|
|
6
|
+
assets. Platform-specific implementations are selected automatically through
|
|
7
|
+
package export conditions, with explicit web and native entry points available
|
|
8
|
+
when needed.
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
pnpm add @vellira-ui/icons
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
Use the platform-aware default entry point in React applications:
|
|
19
|
+
|
|
20
|
+
```tsx
|
|
21
|
+
import { Search, Settings, User } from '@vellira-ui/icons';
|
|
22
|
+
|
|
23
|
+
export function Example() {
|
|
24
|
+
return <Search />;
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
React Native consumers use the same public imports:
|
|
29
|
+
|
|
30
|
+
```tsx
|
|
31
|
+
import { Search } from '@vellira-ui/icons';
|
|
32
|
+
|
|
33
|
+
export function Example() {
|
|
34
|
+
return <Search />;
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Entry Points
|
|
39
|
+
|
|
40
|
+
- `@vellira-ui/icons` — platform-aware default entry
|
|
41
|
+
- `@vellira-ui/icons/web` — explicit web icon entry
|
|
42
|
+
- `@vellira-ui/icons/native` — explicit React Native icon entry
|
|
43
|
+
- `@vellira-ui/icons/lottie` — animated icon data and manifest
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
- [Icons](https://docs.vellira.dev/icons/)
|
|
48
|
+
- [Static Icons](https://docs.vellira.dev/icons/static)
|
|
49
|
+
- [Animated Icons](https://docs.vellira.dev/icons/animated)
|
|
50
|
+
- [Icon Usage](https://docs.vellira.dev/icons/usage)
|
|
6
51
|
|
|
7
52
|
## Development
|
|
8
53
|
|
|
@@ -12,16 +57,25 @@ Generate icons:
|
|
|
12
57
|
pnpm --filter @vellira-ui/icons generate
|
|
13
58
|
```
|
|
14
59
|
|
|
15
|
-
Build
|
|
60
|
+
Build the package:
|
|
16
61
|
|
|
17
62
|
```bash
|
|
18
63
|
pnpm --filter @vellira-ui/icons build
|
|
19
64
|
```
|
|
20
65
|
|
|
21
|
-
|
|
66
|
+
Generated source files live in `src/generated/` and publishable artifacts are
|
|
67
|
+
emitted to `dist`.
|
|
22
68
|
|
|
23
|
-
##
|
|
69
|
+
## Package Structure
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
svg/
|
|
73
|
+
src/
|
|
74
|
+
├── generated/
|
|
75
|
+
├── web.ts
|
|
76
|
+
├── native.ts
|
|
77
|
+
└── lottie.ts
|
|
78
|
+
```
|
|
24
79
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
- The generator currently emits TSX-compatible icon files for native usage.
|
|
80
|
+
Source SVG assets live in `svg/`. Generated icon implementations should not be
|
|
81
|
+
edited manually.
|
package/package.json
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vellira-ui/icons",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.55.0",
|
|
4
4
|
"description": "Cross-platform icon package for Vellira Design System",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"vellira",
|
|
7
|
+
"icons",
|
|
8
|
+
"react",
|
|
9
|
+
"react-native",
|
|
10
|
+
"svg",
|
|
11
|
+
"lottie",
|
|
12
|
+
"design-system",
|
|
13
|
+
"typescript"
|
|
14
|
+
],
|
|
5
15
|
"author": "Roman Bakurov",
|
|
6
16
|
"license": "MIT",
|
|
7
17
|
"repository": {
|
|
@@ -9,6 +19,10 @@
|
|
|
9
19
|
"url": "git+https://github.com/vellira-dev/vellira.git",
|
|
10
20
|
"directory": "packages/icons"
|
|
11
21
|
},
|
|
22
|
+
"homepage": "https://vellira.dev",
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://github.com/vellira-dev/vellira/issues"
|
|
25
|
+
},
|
|
12
26
|
"private": false,
|
|
13
27
|
"type": "module",
|
|
14
28
|
"sideEffects": false,
|