vuetify-nuxt-module 0.19.5 → 1.0.0-alpha.2

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.
@@ -1,18 +1,18 @@
1
1
  declare module 'virtual:vuetify-configuration' {
2
- import type { VuetifyOptions } from 'vuetify';
2
+ import type { VuetifyOptions } from 'vuetify'
3
3
 
4
4
  export const isDev: boolean
5
- export function vuetifyConfiguration(): VuetifyOptions
5
+ export function vuetifyConfiguration (): VuetifyOptions
6
6
  }
7
7
 
8
8
  declare module 'virtual:vuetify-date-configuration' {
9
- import type { DateOptions } from 'vuetify';
9
+ import type { DateOptions } from 'vuetify'
10
10
 
11
11
  export const enabled: boolean
12
12
  export const isDev: boolean
13
13
  export const i18n: boolean
14
14
  export const adapter: 'vuetify' | 'date-fns' | 'moment' | 'luxon' | 'dayjs' | 'js-joda' | 'date-fns-jalali' | 'jalaali' | 'hijri' | 'custom'
15
- export function dateConfiguration(): DateOptions
15
+ export function dateConfiguration (): DateOptions
16
16
  }
17
17
 
18
18
  declare module 'virtual:vuetify-icons-configuration' {
@@ -20,7 +20,7 @@ declare module 'virtual:vuetify-icons-configuration' {
20
20
 
21
21
  export const enabled: boolean
22
22
  export const isDev: boolean
23
- export function iconsConfiguration(): IconOptions
23
+ export function iconsConfiguration (): IconOptions
24
24
  }
25
25
 
26
26
  declare module 'virtual:vuetify-ssr-client-hints-configuration' {
@@ -1,3 +1,3 @@
1
- module.exports.defineVuetifyConfiguration = function(...args) {
1
+ module.exports.defineVuetifyConfiguration = function (...args) {
2
2
  return import('./custom-configuration.mjs').then(m => m.defineVuetifyConfiguration.call(this, ...args))
3
3
  }
@@ -1,3 +1,5 @@
1
1
  import type { ExternalVuetifyOptions } from './dist/module.mjs'
2
- declare function defineVuetifyConfiguration(vuetifyOptions: ExternalVuetifyOptions): ExternalVuetifyOptions;
3
- export { defineVuetifyConfiguration };
2
+
3
+ declare function defineVuetifyConfiguration (vuetifyOptions: ExternalVuetifyOptions): ExternalVuetifyOptions
4
+
5
+ export { defineVuetifyConfiguration }
@@ -1,4 +1,4 @@
1
- function defineVuetifyConfiguration(vuetifyOptions) {
2
- return vuetifyOptions;
1
+ function defineVuetifyConfiguration (vuetifyOptions) {
2
+ return vuetifyOptions
3
3
  }
4
- export { /* #__PURE__ */ defineVuetifyConfiguration };
4
+ export { /* #__PURE__ */ defineVuetifyConfiguration }
package/dist/module.d.mts CHANGED
@@ -237,25 +237,37 @@ interface MOptions {
237
237
  /**
238
238
  * Vuetify styles.
239
239
  *
240
- * If you want to use configFile on SSR, you have to disable `experimental.inlineSSRStyles` in nuxt.config.
240
+ * If you are using Vuetify 3, you can only use the `configFile` option.
241
241
  *
242
+ * The `colors` and `utilities` options are only available for Vuetify 4.
243
+ *
244
+ * @see https://vuetifyjs.com/en/styles/entry-points/#individual-modules
242
245
  * @see https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin
243
- * @see https://github.com/userquin/vuetify-nuxt-module/issues/78 and https://github.com/userquin/vuetify-nuxt-module/issues/74
244
246
  *
245
247
  * @default true
246
248
  */
247
- styles?: true | 'none' | 'sass' | {
249
+ styles?: true | 'none' | {
250
+ /**
251
+ * Path to the custom Vuetify SASS configuration file.
252
+ */
248
253
  configFile: string;
254
+ experimental?: {
255
+ cache?: boolean;
256
+ };
257
+ } | {
258
+ /**
259
+ * Include the standard colors palette?
260
+ *
261
+ * @default true
262
+ */
263
+ colors?: boolean;
264
+ /**
265
+ * Include the standard utilities?
266
+ *
267
+ * @default true
268
+ */
269
+ utilities?: boolean;
249
270
  };
250
- /**
251
- * The module will add `vuetify/styles` in Nuxt `css` by default.
252
- *
253
- * If you want to add custom styles, you should enable this flag to avoid registering `vuetify/styles`.
254
- *
255
- * @see https://github.com/vuetifyjs/nuxt-module/pull/213
256
- * @default false
257
- */
258
- disableVuetifyStyles?: boolean;
259
271
  /**
260
272
  * Disable the modern SASS compiler and API.
261
273
  *
@@ -268,6 +280,7 @@ interface MOptions {
268
280
  * @see https://vitejs.dev/config/shared-options.html#css-preprocessormaxworkers
269
281
  *
270
282
  * @default false
283
+ * @deprecated Vite 7 supports only the modern SASS compiler and API.
271
284
  */
272
285
  disableModernSassCompiler?: boolean;
273
286
  /**
@@ -438,21 +451,50 @@ interface SSRClientHintsConfiguration {
438
451
  };
439
452
  }
440
453
 
454
+ /**
455
+ * Configuration options for the Vuetify Nuxt module.
456
+ */
441
457
  interface ModuleOptions extends VuetifyModuleOptions {
442
458
  }
443
459
  interface ModuleHooks {
460
+ /**
461
+ * Hook called when the module is registered.
462
+ *
463
+ * @param registerModule - A function to register a Vuetify module with inline options.
464
+ */
444
465
  'vuetify:registerModule': (registerModule: (config: InlineModuleOptions) => void) => HookResult;
445
466
  }
446
467
  interface ModuleRuntimeHooks {
468
+ /**
469
+ * Hook called before the Vuetify configuration is resolved.
470
+ * allowing you to modify the configuration.
471
+ *
472
+ * @param options - The configuration options including `isDev` and `vuetifyOptions`.
473
+ */
447
474
  'vuetify:configuration': (options: {
448
475
  isDev: boolean;
449
476
  vuetifyOptions: VuetifyOptions;
450
477
  }) => HookResult;
478
+ /**
479
+ * Hook called before the Vuetify instance is created.
480
+ *
481
+ * @param options - The options used to create the Vuetify instance.
482
+ */
451
483
  'vuetify:before-create': (options: {
452
484
  isDev: boolean;
453
485
  vuetifyOptions: VuetifyOptions;
454
486
  }) => HookResult;
487
+ /**
488
+ * Hook called after the Vuetify instance has been created.
489
+ *
490
+ * @param vuetify - The created Vuetify instance.
491
+ */
455
492
  'vuetify:ready': (vuetify: ReturnType<typeof createVuetify>) => HookResult;
493
+ /**
494
+ * Hook called to configure SSR client hints.
495
+ *
496
+ * @param options - The SSR client hints configuration options.
497
+ */
456
498
  'vuetify:ssr-client-hints': (options: {
457
499
  vuetifyOptions: VuetifyOptions;
458
500
  ssrClientHints: SSRClientHints;
package/dist/module.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "compatibility": {
5
5
  "nuxt": ">=3.15.0"
6
6
  },
7
- "version": "0.19.5",
7
+ "version": "1.0.0-alpha.2",
8
8
  "builder": {
9
9
  "@nuxt/module-builder": "1.0.2",
10
10
  "unbuild": "3.6.1"