@cdx-ui/icons 0.1.1 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +6 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Cross-platform icon library for Forge UI, built on [Material Symbols](https://fonts.google.com/icons) (outlined style, weight 400, optical size 24). Renders via `react-native-svg` and targets iOS, Android, and Web from a single codebase.
6
6
 
7
- ~3,800+ Material Symbols available from Google's metadata; ~3,540 are included in the Figma Code Connect batch manifest. Supports outlined/filled variants, plus custom SVGs.
7
+ The full Material Symbols outlined set is available, with outlined and filled variants for each icon, plus support for custom SVGs. Browse the complete library in the [icon browser](https://design.candescent.com/docs/foundations/expressions/icons).
8
8
 
9
9
  ## Installation
10
10
 
@@ -143,7 +143,7 @@ Cross-platform behavior:
143
143
 
144
144
  React Native >=0.76 aliases `aria-label` to `accessibilityLabel`, so either prop works.
145
145
 
146
- For full details, see [08-accessibility.md](../../docs/internal/research/lucide-react-native/08-accessibility.md).
146
+ For full details, see the [icon accessibility guidance](https://design.candescent.com/docs/foundations/expressions/icons) on the docs site.
147
147
 
148
148
  ## Custom icons
149
149
 
@@ -196,7 +196,7 @@ SVGs are fetched directly from the Google Fonts CDN by a custom download script
196
196
  pnpm --filter @cdx-ui/icons download-icons
197
197
  ```
198
198
 
199
- This downloads ~7,600 SVGs (~3,800 icons × 2 fill states) to `icons/material/outlined/`. Pass `--clean` to re-download from scratch instead of skipping existing files.
199
+ This downloads an outlined and a filled SVG for every icon to `icons/material/outlined/`. Pass `--clean` to re-download from scratch instead of skipping existing files.
200
200
 
201
201
  ### Generating icon components
202
202
 
@@ -232,11 +232,11 @@ Generated files (gitignored, like `src/icons/`):
232
232
  - `src/tab-icons/generated/registry.ts` — `TAB_ICON_NAMES` tuple, `TabIconName` type, and `TAB_ICON_COMPONENTS` map
233
233
  - `src/tab-icons/generated/index.ts` — barrel exporting descriptors + registry
234
234
 
235
- To add an icon to the curated set, add its base name to `tab-icons.config.json` and rebuild — unknown names fail the build. Consumer-facing usage is documented in [docs/icons.md § Bottom Tab Icons](../../docs/icons.md#bottom-tab-icons).
235
+ To add an icon to the curated set, add its base name to `tab-icons.config.json` and rebuild — unknown names fail the build. Consumer-facing usage is documented in the repository's icon guide.
236
236
 
237
237
  ### Tab icon registry
238
238
 
239
- The generation script also emits a **registry module** that provides programmatic access to the curated tab icon set. All three exports are available from the `@cdx-ui/icons/tab-icons` subpath:
239
+ The generation script also emits a **registry module** that provides programmatic access to the curated tab icon set. The registry exports are available from the `@cdx-ui/icons/tab-icons` subpath:
240
240
 
241
241
  | Export | Type | Description |
242
242
  | --------------------- | --------------------------------- | ------------------------------------------------------------------------------ |
@@ -314,4 +314,4 @@ The package follows the patterns established by [lucide-react-native](https://gi
314
314
  - **Decorative by default** — Icons are hidden from assistive technology unless `accessibilityLabel` is provided.
315
315
  - **OTA compatibility** — `childDefaultAttributes` explicitly sets `fill` on every child SVG element, working around an inheritance bug in CodePush/expo-updates.
316
316
 
317
- For the full research and design rationale, see [docs/internal/research/lucide-react-native/](../../docs/internal/research/lucide-react-native/README.md).
317
+ The full research and design rationale is recorded in the repository's icon-package research spike.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cdx-ui/icons",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/dfh-candescent-ui/ui-component-framework",