@cdx-ui/icons 0.0.1-beta.53 → 0.0.1-beta.54
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 +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,6 +47,18 @@ Each icon is a `forwardRef` component that accepts all standard `SvgProps` plus
|
|
|
47
47
|
|
|
48
48
|
All other props are spread onto the root `<Svg>` element, including standard React Native accessibility props.
|
|
49
49
|
|
|
50
|
+
### Factory and types
|
|
51
|
+
|
|
52
|
+
| Export | Description |
|
|
53
|
+
| ----------------- | --------------------------------------------------------------------------- |
|
|
54
|
+
| `createForgeIcon` | Factory function to create custom Forge-style icon components from SVG data |
|
|
55
|
+
| `ForgeIconProps` | Props interface for icons created by the factory |
|
|
56
|
+
| `ForgeIcon` | Type alias for a Forge icon component |
|
|
57
|
+
| `IconNode` | Type for SVG path data consumed by the factory |
|
|
58
|
+
| `IconData` | Type for outlined + filled path data pair |
|
|
59
|
+
|
|
60
|
+
> `createCdxIcon` and `CdxIconProps` / `CdxIcon` are deprecated aliases — use the `Forge` equivalents.
|
|
61
|
+
|
|
50
62
|
### Naming conventions
|
|
51
63
|
|
|
52
64
|
Every icon is available under three export patterns:
|