qwicons 0.2.0 → 0.3.0

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # Qwik Icons
2
2
 
3
- Include lucide icons easily in your Qwik projects with `qwicons` 🚀
3
+ Latest [lucide](https://lucide.dev) icons as Qwik components 🚀
4
4
 
5
5
  ## Installation
6
6
 
@@ -14,10 +14,10 @@ bun add qwicons
14
14
  ## Usage
15
15
 
16
16
  ```tsx
17
- import { LuRocket } from "qwicons/lucide";
17
+ import { LuRocket } from "qwicons";
18
18
 
19
19
  export const MyComponent = component$(() => {
20
- // Icon size and color are inherited by default ⬇️
20
+ // Icon size and color are inherited via CSS ⬇️
21
21
  return (
22
22
  <div style={{ color: "red", fontSize: "40px" }}>
23
23
  <LuRocket />
@@ -26,10 +26,24 @@ export const MyComponent = component$(() => {
26
26
  });
27
27
  ```
28
28
 
29
- ## Available Libraries
29
+ Icons accept all standard SVG props via `IconProps` (`QwikIntrinsicElements["svg"]`):
30
30
 
31
31
  ```tsx
32
- import { LuRocket } from "qwicons/lucide";
32
+ import { LuRocket, type IconProps } from "qwicons";
33
+
34
+ <LuRocket width="24px" height="24px" class="my-icon" />
33
35
  ```
34
36
 
35
- > **Missing a library?** Feel free to [open an issue](https://github.com/xiaofan2406/qwicons/issues/new) 🤝
37
+ ## Icon Names
38
+
39
+ All lucide icons are available with the `Lu` prefix in `CamelCase`:
40
+
41
+ | Import | Lucide icon |
42
+ |--------|-------------|
43
+ | `LuRocket` | `rocket` |
44
+ | `LuChevronDown` | `chevron-down` |
45
+ | `LuCircleCheck` | `circle-check` |
46
+
47
+ Browse all icons at [lucide.dev/icons](https://lucide.dev/icons).
48
+
49
+ > **Missing something?** Feel free to [open an issue](https://github.com/xiaofan2406/qwicons/issues/new) 🤝