Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(icons): Added @vibe/icons/meta to readme #2712

Merged
merged 4 commits into from
Jan 12, 2025
Merged

docs(icons): Added @vibe/icons/meta to readme #2712

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d11f33
docs(icons): Added @vibe/icons/meta to readme
shaharzil Jan 12, 2025
c552252
added metadata content and usage info
shaharzil Jan 12, 2025
6069af0
removed category and ignore from readme
shaharzil Jan 12, 2025
dde635c
Merge branch 'master' into add-icons-meta-to-readme
shaharzil Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/icons/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ import { Close } from "@vibe/icons/lazy";
import { Close as CloseSvg } from "@vibe/icons/raw";
```

#### Using Meta Information

The meta export provides detailed metadata for each icon, including:

- `name`: The name of the icon.
- `file`: The SVG file name.
- `description`: A description of the icon's purpose or usage.
- `tags`: Associated tags as a comma-separated string.
- `category`: (Optional) Icon categories such as `Basic`, `Platform`, or `View`.
- `ignore`: (Optional) Indicates if the icon should be ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove this as it's not relevant for the metadata but only for the catalog, no? @rivka-ungar

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The metadata contains this info...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but how will it benefit the users who use this metadata? 😅

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is used internally to filter out icons we don't want to display in the catalog, so it probably doesn't need to be in the readme

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sababi, removing


This metadata can be used to programmatically work with icons, such as building custom icon pickers or managing icons in your project.

```javascript
import iconsMetaData from "@vibe/icons/meta";
```

## Peer dependencies

Expand Down
Loading