@luminescent/ui 0.7.7 → 0.8.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.
package/README.md CHANGED
@@ -1,48 +1,48 @@
1
- <img src="./branding.png" width="400">
2
-
3
- To use the Luminescent UI Qwik Library, you need to install the package from npm.
4
-
5
- ```bash
6
- npm install @anuragroy/tailwindcss-animate @luminescent/ui
7
- ```
8
-
9
- Once installed, since this is a tailwind based library, you need to include the following to your tailwind config
10
-
11
- The theme and plugins properties are optional if you don't want to use blobs in the Card component
12
-
13
- ```javascript
14
- /** @type {import('tailwindcss').Config} */
15
-
16
- import tailwindConfig from '@luminescent/ui/config';
17
-
18
- export default {
19
- // required
20
- content: [
21
- // ...
22
- ...tailwindConfig.content,
23
- ],
24
- // only for blobs in the Card component
25
- theme: {
26
- extend: {
27
- animation: {
28
- // ...
29
- ...tailwindConfig.theme.extend.animation,
30
- },
31
- keyframes: {
32
- // ...
33
- ...tailwindConfig.theme.extend.keyframes,
34
- },
35
- },
36
- },
37
- plugins: [
38
- // ...
39
- require('@anuragroy/tailwindcss-animate'),
40
- ],
41
- };
42
- ```
43
-
44
- Once finished, you can import the components you need from the package.
45
-
46
- ```javascript
47
- import { Button } from '@luminescent/ui';
48
- ```
1
+ <img src="./branding.png" width="400">
2
+
3
+ To use the Luminescent UI Qwik Library, you need to install the package from npm.
4
+
5
+ ```bash
6
+ npm install @anuragroy/tailwindcss-animate @luminescent/ui
7
+ ```
8
+
9
+ Once installed, since this is a tailwind based library, you need to include the following to your tailwind config
10
+
11
+ The theme and plugins properties are optional if you don't want to use blobs in the Card component
12
+
13
+ ```javascript
14
+ /** @type {import('tailwindcss').Config} */
15
+
16
+ import tailwindConfig from '@luminescent/ui/config';
17
+
18
+ export default {
19
+ // required
20
+ content: [
21
+ // ...
22
+ ...tailwindConfig.content,
23
+ ],
24
+ // only for blobs in the Card component
25
+ theme: {
26
+ extend: {
27
+ animation: {
28
+ // ...
29
+ ...tailwindConfig.theme.extend.animation,
30
+ },
31
+ keyframes: {
32
+ // ...
33
+ ...tailwindConfig.theme.extend.keyframes,
34
+ },
35
+ },
36
+ },
37
+ plugins: [
38
+ // ...
39
+ require('@anuragroy/tailwindcss-animate'),
40
+ ],
41
+ };
42
+ ```
43
+
44
+ Once finished, you can import the components you need from the package.
45
+
46
+ ```javascript
47
+ import { Button } from '@luminescent/ui';
48
+ ```