@primeicons/lit 8.0.0-alpha.4 → 8.0.0-alpha.5

package/README.md

@@ -247,6 +247,61 @@ Each icon element includes these CSS classes:
 - `p-icon` - Base class for all icons
 - `p-icon-{name}` - Specific class for each icon (e.g., `p-icon-search`)
 
+## Metadata & Icon Lookup
+
+Icon metadata is managed by the `@primeicons/metadata` package and re-exported here for convenience:
+
+```typescript
+import { ICON_MAP, ICON_MAP_BY_NAME, findIcons } from '@primeicons/metadata/lit';
+
+// Find icon by name (kebab-case)
+const iconData = ICON_MAP_BY_NAME['check'];
+
+// Web components use pi-{name} tag names
+const tagName = `pi-${iconData.name}`; // 'pi-check'
+
+// Search and use
+const results = findIcons('arrow');
+results.forEach((icon) => {
+    const element = document.createElement(`pi-${icon.name}`);
+    element.size = 24;
+    // Use element...
+});
+```
+
+Alternatively, import directly from the metadata package:
+
+```typescript
+import { ICON_MAP, findIcons } from '@primeicons/metadata/lit';
+```
+
+### Metadata API
+
+| Variable                | Type                                | Description                |
+| ----------------------- | ----------------------------------- | -------------------------- |
+| `ICON_MAP`              | `IconMetadataEntry[]`               | All icons as array         |
+| `ICON_MAP_BY_NAME`      | `Record<string, IconMetadataEntry>` | Indexed by kebab-case name |
+| `ICON_MAP_BY_COMPONENT` | `Record<string, IconMetadataEntry>` | Indexed by component name  |
+| `ICON_MAP_BY_CAMEL`     | `Record<string, IconMetadataEntry>` | Indexed by camelCase name  |
+| `TOTAL_ICONS`           | `number`                            | Total icon count           |
+| `PACKAGE_INFO`          | `object`                            | Package metadata           |
+
+| Function              | Returns               | Description                   |
+| --------------------- | --------------------- | ----------------------------- |
+| `getIconNames()`      | `string[]`            | All kebab-case icon names     |
+| `getComponentNames()` | `string[]`            | All component names           |
+| `findIcons(query)`    | `IconMetadataEntry[]` | Search icons by partial match |
+
+### JSON Metadata
+
+Access the raw JSON metadata directly:
+
+```typescript
+import metadata from '@primeicons/metadata/lit.json';
+
+console.log(manifest.icons[0]); // { name: 'address-book', component: 'AddressBook', ... }
+```
+
 ## Icon List
 
 The library includes 300+ icons including:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primeicons/lit",
-  "version": "8.0.0-alpha.4",
+  "version": "8.0.0-alpha.5",
   "author": "PrimeTek Informatics",
   "homepage": "https://primeicons.org/",
   "description": "PrimeIcons for Lit - 300+ customizable SVG icons as Lit web components",
@@ -53,7 +53,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@primeicons/core": "8.0.0-alpha.4"
+    "@primeicons/core": "8.0.0-alpha.5"
   },
   "peerDependencies": {
     "lit": ">=2"