@puzzle-ui/icons 0.5.0 → 0.5.1

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 +12 -38
  2. package/package.json +7 -2
package/README.md CHANGED
@@ -1,24 +1,19 @@
1
1
  # @puzzle-ui/icons
2
2
 
3
- React icon components backed by Iconify. Use named icons in your application
4
- or alongside Puzzle UI components.
3
+ React `Icon` component backed by Iconify. Render an icon by passing an Iconify `prefix:name` identifier, and style it with CSS, `currentColor`, or Puzzle theme tokens. Use it when you want a consistent SVG component API without importing individual icon files.
5
4
 
6
- > Puzzle is under active development. APIs and framework compatibility may
7
- > change; use it for experimentation and evaluation rather than production.
5
+ **Documentation: [puzzle-ui.com/docs/icons](https://puzzle-ui.com/docs/icons)**
8
6
 
9
- ## Installation
7
+ ## Install
10
8
 
11
9
  ```sh
12
10
  npm install @puzzle-ui/icons
13
- # or
14
- bun add @puzzle-ui/icons
15
- # or
16
- pnpm add @puzzle-ui/icons
17
- # or
18
- yarn add @puzzle-ui/icons
11
+ # or: bun add @puzzle-ui/icons
12
+ # or: pnpm add @puzzle-ui/icons
13
+ # or: yarn add @puzzle-ui/icons
19
14
  ```
20
15
 
21
- Requires React and React DOM 19 (`^19.0.0`). No theme provider is required.
16
+ Requires React and React DOM `^19.0.0` as peer dependencies. No theme provider is required.
22
17
 
23
18
  ## Usage
24
19
 
@@ -30,29 +25,11 @@ export const HomeIcon = () => (
30
25
  );
31
26
  ```
32
27
 
33
- `Icon` accepts a collection-prefixed `name`, optional numeric `size` in
34
- pixels, optional `color`, and SVG attributes. Without an explicit color,
35
- it can inherit the surrounding text color.
28
+ `Icon` accepts a required `name`, optional pixel `size`, CSS `color`, an optional `showLoader`, and standard SVG attributes. By default, it uses `1em` sizing and inherits `currentColor`. For icon-only controls, label the control and mark the icon decorative with `aria-hidden="true"`.
36
29
 
37
- For icon-only controls, label the control and keep its icon decorative:
30
+ ## Exports and runtime
38
31
 
39
- ```tsx
40
- <button type="button" aria-label="Search">
41
- <Icon name="lucide:search" aria-hidden="true" />
42
- </button>
43
- ```
44
-
45
- Icon loading can make external requests to Iconify. Account for network
46
- availability and your Content Security Policy. Framework compatibility is
47
- still being evaluated.
48
-
49
- ## Exports
50
-
51
- - `Icon`, `IconProps`
52
-
53
- Import from `@puzzle-ui/icons`; generated internal icon-set files are not
54
- exported package entry points. ESM and CommonJS builds and TypeScript
55
- declarations are included.
32
+ The package root exports `Icon` and `IconProps`; it does not export each icon as a separate component or expose generated collection files as subpaths. ESM, CommonJS, and TypeScript declarations are included. Iconify may load icon data over the network, so consider network availability and your Content Security Policy. Check the relevant icon collection's license before using its artwork.
56
33
 
57
34
  ## Development
58
35
 
@@ -64,11 +41,8 @@ npm run build --workspace=@puzzle-ui/icons
64
41
  bun run vitest
65
42
  ```
66
43
 
67
- `prepack` rebuilds the package before packing or publishing. See the root
68
- [publishing guide](../../README.md#publishing-packages).
44
+ `prepack` rebuilds the package before packing or publishing. See the root [publishing guide](../../README.md#publishing-packages).
69
45
 
70
46
  ## License
71
47
 
72
- Package code is MIT; see [LICENSE](../../LICENSE), also included at
73
- `dist/LICENSE` in published packages. Individual icon collections may carry
74
- their own licenses; check the collection's terms before using its artwork.
48
+ Package code is MIT; see [LICENSE](../../LICENSE), also included at `dist/LICENSE` in published packages. Individual icon collections may carry their own licenses; check the collection's terms before use.
package/package.json CHANGED
@@ -1,7 +1,12 @@
1
1
  {
2
2
  "name": "@puzzle-ui/icons",
3
- "version": "0.5.0",
3
+ "version": "0.5.1",
4
4
  "description": "Icons for Puzzle",
5
+ "homepage": "https://puzzle-ui.com",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/senorprogramador/puzzle.git"
9
+ },
5
10
  "license": "MIT",
6
11
  "publishConfig": {
7
12
  "access": "public",
@@ -38,7 +43,7 @@
38
43
  "dependencies": {
39
44
  "@iconify/react": "^6.0.3",
40
45
  "@iconify/utils": "^3.1.7",
41
- "@puzzle-ui/core": "^0.5.0"
46
+ "@puzzle-ui/core": "^0.5.1"
42
47
  },
43
48
  "peerDependencies": {
44
49
  "react": "^19.0.0",