@nr1e/qwik-ui 0.0.7 → 0.0.8

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 (3) hide show
  1. package/README.md +32 -5
  2. package/package.json +5 -3
  3. package/styles.css +1 -0
package/README.md CHANGED
@@ -2,12 +2,39 @@
2
2
  <img width="200" src="https://nr1e.com/images/logo-tagline.svg" />
3
3
  </div>
4
4
 
5
- # Qwik Icons Library ⚡️
5
+ # Qwik UI Library ⚡️
6
6
 
7
- This library contains approved icons for use in NR1E projects.
7
+ This library contains approved UI components for use in NR1E projects.
8
8
 
9
- ## Prefixes
9
+ ## Installation
10
10
 
11
- Each icon has a prefix identifying where it came from.
11
+ ```bash
12
+ pnpm i @nr1e/qwik-ui
13
+ ```
12
14
 
13
- - **Mdi** = [Material Design Icons](https://icon-sets.iconify.design/mdi/)
15
+ ## Usage with Tailwind CSS 4.x
16
+
17
+ This library uses Tailwind CSS classes (with DaisyUI components). To ensure the classes are properly scanned and generated in your project, you need to import the library's styles configuration.
18
+
19
+ In your main CSS file (e.g., `src/global.css`):
20
+
21
+ ```css
22
+ @import 'tailwindcss';
23
+ @import '@nr1e/qwik-ui/styles.css' source;
24
+
25
+ /* Your other styles */
26
+ ```
27
+
28
+ This tells Tailwind v4 to scan the `@nr1e/qwik-ui` library files for class names and include DaisyUI plugin.
29
+
30
+ ### Alternative: Manual Configuration
31
+
32
+ If you prefer more control, you can manually add the source path in your CSS:
33
+
34
+ ```css
35
+ @import 'tailwindcss';
36
+
37
+ @source '../src';
38
+ @source '../../node_modules/@nr1e/qwik-ui/lib';
39
+ @plugin 'daisyui';
40
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nr1e/qwik-ui",
3
- "version": "0.0.7",
3
+ "version": "0.0.8",
4
4
  "description": "NR1E Qwik UI Library",
5
5
  "author": "NR1E, Inc.",
6
6
  "publishConfig": {
@@ -19,11 +19,13 @@
19
19
  "import": "./lib/index.qwik.mjs",
20
20
  "require": "./lib/index.qwik.cjs",
21
21
  "types": "./lib-types/index.d.ts"
22
- }
22
+ },
23
+ "./styles.css": "./styles.css"
23
24
  },
24
25
  "files": [
25
26
  "lib",
26
- "lib-types"
27
+ "lib-types",
28
+ "styles.css"
27
29
  ],
28
30
  "engines": {
29
31
  "node": "^18.17.0 || ^20.3.0 || >=21.0.0"
package/styles.css ADDED
@@ -0,0 +1 @@
1
+ @source './lib';