@uiuxicons/vue 0.1.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 UI/UX Icons
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,76 @@
1
+ # @uiuxicons/vue
2
+
3
+ Vue components for [UI/UX Icons](https://uiuxicons.com) - a clean, consistent icon library for modern interfaces.
4
+
5
+ **3 styles** (line, duotone, solid) × **3 weights** (light, regular, bold) = 9 variants per icon.
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install @uiuxicons/vue
11
+ ```
12
+
13
+ Requires **Vue 3.5** or later.
14
+
15
+ ## Usage
16
+
17
+ ```vue
18
+ <script setup>
19
+ import { IconGear, IconHouse, IconCalendar } from "@uiuxicons/vue";
20
+ </script>
21
+
22
+ <template>
23
+ <IconGear />
24
+ <IconGear variant="duotone" weight="bold" />
25
+ <IconGear variant="solid" :size="32" class="text-blue-500" />
26
+ </template>
27
+ ```
28
+
29
+ ## Props
30
+
31
+ | Prop | Type | Default |
32
+ |------|------|---------|
33
+ | `variant` | `"line"` \| `"duotone"` \| `"solid"` | `"line"` |
34
+ | `weight` | `"light"` \| `"regular"` \| `"bold"` | `"regular"` |
35
+ | `size` | `number` \| `string` | `24` |
36
+ | `color` | `string` | inherits from CSS |
37
+ | `title` | `string` | - |
38
+
39
+ All standard SVG attributes are also accepted.
40
+
41
+ ## Duotone Accent
42
+
43
+ The accent layer uses 25% opacity of the current color by default. Override with the `--uiux-accent` CSS variable:
44
+
45
+ ```vue
46
+ <template>
47
+ <IconGear
48
+ variant="duotone"
49
+ class="text-foreground"
50
+ style="--uiux-accent: var(--color-primary)"
51
+ />
52
+ </template>
53
+ ```
54
+
55
+ ## Accessibility
56
+
57
+ Icons are decorative by default (`aria-hidden="true"`). Add `aria-label` or `title` to make them meaningful:
58
+
59
+ ```vue
60
+ <template>
61
+ <IconGear aria-label="Settings" />
62
+ <IconGear title="Settings" />
63
+ </template>
64
+ ```
65
+
66
+ ## Tree-shaking
67
+
68
+ The package is marked `sideEffects: false` with named exports. Import only the icons you need - unused icons are removed by your bundler.
69
+
70
+ ## License
71
+
72
+ MIT - free for personal and commercial use.
73
+
74
+ ---
75
+
76
+ **[uiuxicons.com](https://uiuxicons.com)** · [GitHub](https://github.com/uiuxassets/uiuxicons) · Made by [UI/UX Icons](https://uiuxicons.com)