feat: support non-loader based visual editing

nuxt-modules · Mar 5, 2024 · dbd3f88 · dbd3f88
1 parent 6f589a8
commit dbd3f88
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 10 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -20,7 +20,7 @@ declare module 'nuxt/schema' {
                   enable: string
                   disable: string
                 }
-            mode: 'global' | 'component'
+            mode: 'loaders' | 'basic' | 'manual'
             studioUrl: string
             previewModeId: string
             token: string
@@ -48,7 +48,7 @@ declare module 'nuxt/schema' {
                   enable: string
                   disable: string
                 }
-            mode: 'global' | 'component'
+            mode: 'loaders' | 'basic' | 'manual'
             studioUrl: string
           }
         | nullish

diff --git a/src/module.ts b/src/module.ts
@@ -38,9 +38,9 @@ export interface SanityModuleVisualEditingOptions {
   }
   /**
    * Enable visual editing at app level or per component
-   * @default 'global'
+   * @default 'loaders'
    */
-  mode?: 'global' | 'component'
+  mode?: 'loaders' | 'basic' | 'manual'
   /**
    * Read token for server side queries
    * @required
@@ -162,7 +162,7 @@ export default defineNuxtModule<SanityModuleOptions>({
           disable: '/preview/disable',
         })
         : false) as { enable: string; disable: string } | false,
-      mode: options.visualEditing.mode || 'global',
+      mode: options.visualEditing.mode || 'loaders',
       studioUrl: options.visualEditing.studioUrl || '',
     }
 
@@ -289,8 +289,7 @@ export default defineNuxtModule<SanityModuleOptions>({
       })
 
       if (
-        options.visualEditing.mode === undefined ||
-        options.visualEditing.mode === 'global'
+        options.visualEditing.mode !== 'manual'
       ) {
         addPlugin({
           mode: 'client',

diff --git a/src/runtime/visual-editing/composables.ts b/src/runtime/visual-editing/composables.ts
@@ -22,7 +22,7 @@ export interface SanityVisualEditingConfiguration {
     enable?: string
     disable?: string
   }
-  mode: 'global' | 'component'
+  mode: 'loaders' | 'basic' | 'manual'
   token?: string
   studioUrl: string
   previewModeId?: string

diff --git a/src/runtime/visual-editing/plugins/client.ts b/src/runtime/visual-editing/plugins/client.ts
@@ -1,7 +1,9 @@
 // @ts-ignore
 import { defineNuxtPlugin, useSanityVisualEditing } from '#imports'
 
-export default defineNuxtPlugin(() => {
+export default defineNuxtPlugin((nuxtApp) => {
   useSanityVisualEditing()
-  useSanityLiveMode()
+  if(nuxtApp.$config.public.sanity.visualEditing?.mode !== 'basic') {
+    useSanityLiveMode()
+  }
 })