feat: add options.debug flag for console output

#101
pulsardev · Feb 3, 2020 · effbd1d · effbd1d
1 parent d2a6cd9
commit effbd1d
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/src/components/VStep.vue b/src/components/VStep.vue
@@ -58,6 +58,9 @@ export default {
     },
     highlight: {
       type: Boolean
+    },
+    debug: {
+      type: Boolean
     }
   },
   data () {
@@ -77,8 +80,9 @@ export default {
   },
   methods: {
     createStep () {
-      // TODO: debug mode
-      // console.log('[Vue Tour] The target element ' + this.step.target + ' of .v-step[id="' + this.hash + '"] is:', targetElement)
+      if (this.debug) {
+        console.log('[Vue Tour] The target element ' + this.step.target + ' of .v-step[id="' + this.hash + '"] is:', this.targetElement)
+      }
 
       if (this.targetElement) {
         this.enableScrolling()
@@ -91,7 +95,9 @@ export default {
           this.params
         )
       } else {
-        console.error('[Vue Tour] The target element ' + this.step.target + ' of .v-step[id="' + this.hash + '"] does not exist!')
+        if (this.debug) {
+          console.error('[Vue Tour] The target element ' + this.step.target + ' of .v-step[id="' + this.hash + '"] does not exist!')
+        }
         this.$emit('targetNotFound', this.step)
       }
     },
@@ -113,7 +119,9 @@ export default {
       }
     },
     isHighlightEnabled () {
-      console.log(`[Vue Tour] Highlight is ${this.params.highlight ? 'enabled' : 'disabled'} for .v-step[id="${this.hash}"]`)
+      if (this.debug) {
+        console.log(`[Vue Tour] Highlight is ${this.params.highlight ? 'enabled' : 'disabled'} for .v-step[id="${this.hash}"]`)
+      }
       return this.params.highlight
     },
     createHighlight () {

diff --git a/src/components/VTour.vue b/src/components/VTour.vue
@@ -10,6 +10,7 @@
       :is-last="isLast"
       :labels="customOptions.labels"
       :highlight="customOptions.highlight"
+      :debug="customOptions.debug"
     >
       <!--Default slot {{ currentStep }}-->
       <v-step
@@ -23,6 +24,7 @@
         :is-last="isLast"
         :labels="customOptions.labels"
         :highlight="customOptions.highlight"
+        :debug="customOptions.debug"
       >
         <!--<div v-if="index === 2" slot="actions">
           <a @click="nextStep">Next step</a>
@@ -128,8 +130,9 @@ export default {
     },
 
     handleKeyup (e) {
-      // TODO: debug mode
-      // console.log('[Vue Tour] A keyup event occured:', e)
+      if (this.customOptions.debug) {
+        console.log('[Vue Tour] A keyup event occured:', e)
+      }
       switch (e.keyCode) {
         case KEYS.ARROW_RIGHT:
           this.nextStep()

diff --git a/src/shared/constants.js b/src/shared/constants.js
@@ -14,7 +14,8 @@ export const DEFAULT_OPTIONS = {
     buttonStop: 'Finish'
   },
   startTimeout: 0,
-  useKeyboardNavigation: true
+  useKeyboardNavigation: true,
+  debug: false
 }
 
 export const HIGHLIGHT = {