Close #1124 virtual-tour: add showLoader transition option

mistic100 · Oct 26, 2023 · b5c102d · b5c102d
1 parent ec3e401
commit b5c102d
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 7 deletions.
diff --git a/docs/plugins/virtual-tour.md b/docs/plugins/virtual-tour.md
@@ -389,7 +389,7 @@ Enable the preloading of linked nodes, can be a function that returns true or fa
 #### `transitionOptions`
 
 -   type: `object | function`
--   default: `{ speed: '20rpm', fadeIn: true, rotation: true }`
+-   default: `{ showLoader: true, speed: '20rpm', fadeIn: true, rotation: true }`
 -   updatable: no
 
 Configuration of the transition between nodes. Can be a callback.
@@ -404,6 +404,11 @@ The default behaviour is to rotate the view to face the direction of the link an
 
 ```ts
 {
+    /**
+     * Show the loader while loading the new panorama
+     * @default true
+     */
+    showLoader?: boolean;
     /**
      * Speed or duration of the transition between nodes
      * @default '20rpm'
@@ -426,6 +431,7 @@ The default behaviour is to rotate the view to face the direction of the link an
 
 ```ts
 (toNode: Node, fromNode?: Node, fromLink?: NodeLink) => ({
+    showLoader?: boolean;
     speed?: string | number;
     fadeIn?: boolean;
     rotation?: boolean;

diff --git a/examples/plugin-virtual-tour.html b/examples/plugin-virtual-tour.html
@@ -185,6 +185,7 @@
                         preload: true,
                         arrowPosition: 'bottom',
                         transitionOptions: {
+                            // showLoader: false,
                             // speed: '10rpm',
                             // fadeIn: false,
                             // rotation: false,

diff --git a/packages/virtual-tour-plugin/src/VirtualTourPlugin.ts b/packages/virtual-tour-plugin/src/VirtualTourPlugin.ts
@@ -31,6 +31,7 @@ const getConfig = utils.getConfigParser<VirtualTourPluginConfig>(
         startNodeId: null,
         preload: false,
         transitionOptions: {
+            showLoader: true,
             speed: '20rpm',
             fadeIn: true,
             rotation: true,
@@ -393,9 +394,7 @@ export class VirtualTourPlugin extends AbstractConfigurablePlugin<
                 }
 
                 const transitionOptions: VirtualTourTransitionOptions = {
-                    speed: (getConfig.defaults.transitionOptions as any).speed,
-                    fadeIn: (getConfig.defaults.transitionOptions as any).fadeIn,
-                    rotation: (getConfig.defaults.transitionOptions as any).rotation,
+                    ...getConfig.defaults.transitionOptions,
                     rotateTo: fromLinkPosition,
                     ...(typeof this.config.transitionOptions === 'function'
                         ? this.config.transitionOptions(node, fromNode, fromLink)
@@ -419,7 +418,9 @@ export class VirtualTourPlugin extends AbstractConfigurablePlugin<
                     throw utils.getAbortError();
                 }
 
-                this.viewer.loader.show();
+                if (transitionOptions.showLoader) {
+                    this.viewer.loader.show();
+                }
 
                 this.state.currentNode = node;
 
@@ -443,6 +444,7 @@ export class VirtualTourPlugin extends AbstractConfigurablePlugin<
                         panoData: node.panoData,
                         sphereCorrection: node.sphereCorrection,
                         transition: !transitionOptions.fadeIn ? false : transitionOptions.rotation ? true : 'fade-only',
+                        showLoader: transitionOptions.showLoader,
                         speed: transitionOptions.speed,
                         position: transitionOptions.rotateTo,
                         zoom: transitionOptions.zoomTo,

diff --git a/packages/virtual-tour-plugin/src/model.ts b/packages/virtual-tour-plugin/src/model.ts
@@ -63,6 +63,11 @@ export type VirtualTourMarkerStyle = Omit<
  * Behaviour of the transition between nodes
  */
 export type VirtualTourTransitionOptions = {
+    /**
+     * Show the loader while loading the new panorama
+     * @default true
+     */
+    showLoader?: boolean;
     /**
      * Speed or duration of the transition between nodes
      * @default '20rpm'
@@ -216,10 +221,10 @@ export type VirtualTourPluginConfig = {
 
     /**
      * Configuration of the transition between nodes. Can be a callback.
-     * @default `{ speed: '20rpm', fadeIn: true, rotation: true }`
+     * @default `{ showLoader: true, speed: '20rpm', fadeIn: true, rotation: true }`
      */
     transitionOptions?:
-        | Pick<VirtualTourTransitionOptions, 'speed' | 'fadeIn' | 'rotation'>
+        | Pick<VirtualTourTransitionOptions, 'showLoader' | 'speed' | 'fadeIn' | 'rotation'>
         | ((
               toNode: VirtualTourNode,
               fromNode?: VirtualTourNode,