@nuxt/ui 3.0.0-alpha.5 → 3.0.0-alpha.6

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
@@ -40,11 +40,13 @@ export default defineNuxtConfig({
40
40
  })
41
41
  ```
42
42
 
43
- 3. Import Tailwind and Nuxt UI in your `app.vue` or in your [CSS](https://nuxt.com/docs/getting-started/styling#the-css-property):
43
+ 3. Import Tailwind CSS and Nuxt UI in your `app.vue` or [CSS](https://nuxt.com/docs/getting-started/styling#the-css-property):
44
44
 
45
- ```css [main.css]
45
+ ```vue [app.vue]
46
+ <style>
46
47
  @import "tailwindcss";
47
48
  @import "@nuxt/ui";
49
+ </style>
48
50
  ```
49
51
 
50
52
  ## Documentation
package/dist/module.d.mts CHANGED
@@ -4,23 +4,37 @@ export * from '../dist/runtime/types/index.js';
4
4
  interface ModuleOptions {
5
5
  /**
6
6
  * Prefix for components
7
- * @defaultValue U
7
+ * @defaultValue `U`
8
+ * @see https://ui3.nuxt.dev/getting-started/installation#prefix
8
9
  */
9
10
  prefix?: string;
10
11
  /**
11
12
  * Enable or disable `@nuxt/fonts` module
12
- * @defaultValue true
13
+ * @defaultValue `true`
14
+ * @see https://ui3.nuxt.dev/getting-started/installation#fonts
13
15
  */
14
16
  fonts?: boolean;
17
+ /**
18
+ * Enable or disable `@nuxtjs/color-mode` module
19
+ * @defaultValue `true`
20
+ * @see https://ui3.nuxt.dev/getting-started/installation#colormode
21
+ */
22
+ colorMode?: boolean;
23
+ /**
24
+ * Customize how the theme is generated
25
+ * @see https://ui3.nuxt.dev/getting-started/theme
26
+ */
15
27
  theme?: {
16
28
  /**
17
- * Colors to generate classes for (defaults to TailwindCSS colors)
18
- * @defaultValue ['red', 'orange', 'amber', 'yellow', 'lime', 'green', 'emerald', 'teal', 'cyan', 'sky', 'blue', 'indigo', 'violet', 'purple', 'fuchsia', 'pink', 'rose']
29
+ * Define the color aliases available for components
30
+ * @defaultValue `['primary', 'secondary', 'success', 'info', 'warning', 'error']`
31
+ * @see https://ui3.nuxt.dev/getting-started/installation#themecolors
19
32
  */
20
33
  colors?: string[];
21
34
  /**
22
35
  * Enable or disable transitions on components
23
- * @defaultValue true
36
+ * @defaultValue `true`
37
+ * @see https://ui3.nuxt.dev/getting-started/installation#themetransitions
24
38
  */
25
39
  transitions?: boolean;
26
40
  };
package/dist/module.d.ts CHANGED
@@ -4,23 +4,37 @@ export * from '../dist/runtime/types/index.js';
4
4
  interface ModuleOptions {
5
5
  /**
6
6
  * Prefix for components
7
- * @defaultValue U
7
+ * @defaultValue `U`
8
+ * @see https://ui3.nuxt.dev/getting-started/installation#prefix
8
9
  */
9
10
  prefix?: string;
10
11
  /**
11
12
  * Enable or disable `@nuxt/fonts` module
12
- * @defaultValue true
13
+ * @defaultValue `true`
14
+ * @see https://ui3.nuxt.dev/getting-started/installation#fonts
13
15
  */
14
16
  fonts?: boolean;
17
+ /**
18
+ * Enable or disable `@nuxtjs/color-mode` module
19
+ * @defaultValue `true`
20
+ * @see https://ui3.nuxt.dev/getting-started/installation#colormode
21
+ */
22
+ colorMode?: boolean;
23
+ /**
24
+ * Customize how the theme is generated
25
+ * @see https://ui3.nuxt.dev/getting-started/theme
26
+ */
15
27
  theme?: {
16
28
  /**
17
- * Colors to generate classes for (defaults to TailwindCSS colors)
18
- * @defaultValue ['red', 'orange', 'amber', 'yellow', 'lime', 'green', 'emerald', 'teal', 'cyan', 'sky', 'blue', 'indigo', 'violet', 'purple', 'fuchsia', 'pink', 'rose']
29
+ * Define the color aliases available for components
30
+ * @defaultValue `['primary', 'secondary', 'success', 'info', 'warning', 'error']`
31
+ * @see https://ui3.nuxt.dev/getting-started/installation#themecolors
19
32
  */
20
33
  colors?: string[];
21
34
  /**
22
35
  * Enable or disable transitions on components
23
- * @defaultValue true
36
+ * @defaultValue `true`
37
+ * @see https://ui3.nuxt.dev/getting-started/installation#themetransitions
24
38
  */
25
39
  transitions?: boolean;
26
40
  };
package/dist/module.json CHANGED
@@ -4,7 +4,8 @@
4
4
  "compatibility": {
5
5
  "nuxt": ">=3.13.1"
6
6
  },
7
- "version": "3.0.0-alpha.5",
7
+ "docs": "https://ui3.nuxt.dev/getting-started/installation",
8
+ "version": "3.0.0-alpha.6",
8
9
  "builder": {
9
10
  "@nuxt/module-builder": "0.8.4",
10
11
  "unbuild": "2.0.0"