feat: add inlineSSRStyles hint to types (#79)

* Update index.md Add mention about disabling inlineSSRStyles when configFile and SSR. Link to the issue. * doc: change to mention only SSR and link to issue 74 * chore: include hints in types --------- Co-authored-by: userquin <userquin@gmail.com>
userquin · Sep 9, 2023 · 97a6f07 · 97a6f07
1 parent 7fc589e
commit 97a6f07
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -111,7 +111,10 @@ export interface MOptions {
   /**
    * Vuetify styles.
    *
+   * If you want to use configFile on SSR, you have to disable `experimental.inlineSSRStyles` in nuxt.config.
+   *
    * @see https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin
+   * @see https://github.com/userquin/vuetify-nuxt-module/issues/78 and https://github.com/userquin/vuetify-nuxt-module/issues/74
    */
   styles?: true | 'none' | 'expose' | 'sass' | {
     configFile: string

diff --git a/src/types.ts b/src/types.ts
@@ -193,7 +193,10 @@ export interface MOptions {
   /**
    * Vuetify styles.
    *
+   * If you want to use configFile on SSR, you have to disable `experimental.inlineSSRStyles` in nuxt.config.
+   *
    * @see https://github.com/vuetifyjs/vuetify-loader/tree/master/packages/vite-plugin
+   * @see https://github.com/userquin/vuetify-nuxt-module/issues/78 and https://github.com/userquin/vuetify-nuxt-module/issues/74
    */
   styles?: true | 'none' | 'expose' | 'sass' | {
     configFile: string