Skip to content

Commit 68d783d

Browse files
authored
docs(icons): Added @vibe/icons/meta to readme (#2712)
1 parent a3da710 commit 68d783d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

packages/icons/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ import { Close } from "@vibe/icons/lazy";
3131
import { Close as CloseSvg } from "@vibe/icons/raw";
3232
```
3333

34+
#### Using Meta Information
35+
36+
The meta export provides detailed metadata for each icon, including:
37+
38+
- `name`: The name of the icon.
39+
- `file`: The SVG file name.
40+
- `description`: A description of the icon's purpose or usage.
41+
- `tags`: Associated tags as a comma-separated string.
42+
43+
This metadata can be used to programmatically work with icons, such as building custom icon pickers or managing icons in your project.
44+
45+
```javascript
46+
import iconsMetaData from "@vibe/icons/meta";
47+
```
3448

3549
## Peer dependencies
3650

0 commit comments

Comments
 (0)