vue-tour - npm Package Compare versions

Comparing version 1.6.0 to 2.0.0

CHANGELOG.md

@@ -5,2 +5,21 @@ # Changelog
 
+# [2.0.0](https://github.com/pulsardev/vue-tour/compare/v1.6.0...v2.0.0) (2021-03-28)
+
+
+### Bug Fixes
+
+* change offset and shadow ([6359b43](https://github.com/pulsardev/vue-tour/commit/6359b43))
+* fix the arrow position ([4a2297b](https://github.com/pulsardev/vue-tour/commit/4a2297b))
+
+
+### Features
+
+* update Popper.js to v2.x ([5d8f790](https://github.com/pulsardev/vue-tour/pull/177/commits/5d8f790))
+
+
+### BREAKING CHANGES
+
+* **Popper.js:** as Popper.js has been updated, all custom Popper.js options passed in step params must be changed to their Popper.js v2.x equivalent.
+* **options:** all custom options are now in camelCase. If you customized highlight classes, you should change the options' keys to camelCase. See ([9041d2f](https://github.com/pulsardev/vue-tour/commit/9041d2f)) for the complete change.
+
 ## [1.6.0](https://github.com/pulsardev/vue-tour/compare/v1.5.0...v1.6.0) (2021-03-27)
@@ -7,0 +26,0 @@

package.json

 {
   "name": "vue-tour",
-  "version": "1.6.0",
+  "version": "2.0.0",
   "description": "Vue Tour is a lightweight, simple and customizable tour plugin for use with Vue.js. It provides a quick and easy way to guide your users through your application.",
@@ -26,22 +26,22 @@ "author": "Pulsar <[e-mail]>",
   "dependencies": {
+    "@popperjs/core": "^2.9.1",
     "hash-sum": "^2.0.0",
     "jump.js": "^1.0.2",
-    "popper.js": "^1.16.0",
-    "vue": "^2.6.10"
+    "vue": "^2.6.12"
   },
   "devDependencies": {
-    "@vue/cli-plugin-babel": "^4.1.0",
-    "@vue/cli-plugin-eslint": "^4.1.0",
-    "@vue/cli-plugin-unit-jest": "^4.1.0",
-    "@vue/cli-service": "^4.1.0",
+    "@vue/cli-plugin-babel": "^4.5.12",
+    "@vue/cli-plugin-eslint": "^4.5.12",
+    "@vue/cli-plugin-unit-jest": "^4.5.12",
+    "@vue/cli-service": "^4.5.12",
     "@vue/eslint-config-standard": "^4.0.0",
-    "@vue/test-utils": "1.0.0-beta.29",
-    "babel-eslint": "^10.0.3",
-    "core-js": "^3.4.3",
+    "@vue/test-utils": "^1.1.3",
+    "babel-eslint": "^10.1.0",
+    "core-js": "^3.9.1",
     "eslint": "^5.16.0",
     "eslint-plugin-vue": "^5.0.0",
-    "sass": "^1.23.7",
-    "sass-loader": "^8.0.0",
-    "vue-template-compiler": "^2.6.10"
+    "sass": "^1.32.8",
+    "sass-loader": "^8.0.2",
+    "vue-template-compiler": "^2.6.12"
   }
 }

src/shared/constants.js

@@ -25,7 +25,8 @@ export const DEFAULT_CALLBACKS = {
   startTimeout: 0,
+  stopOnTargetNotFound: true,
   useKeyboardNavigation: true,
   enabledNavigationKeys: {
-    ESCAPE: true,
-    ARROW_RIGHT: true,
-    ARROW_LEFT: true
+    escape: true,
+    arrowRight: true,
+    arrowLeft: true
   },
@@ -36,11 +37,8 @@ debug: false
 export const HIGHLIGHT = {
-  CLASSES: {
-    ACTIVE: 'v-tour--active',
-    TARGET_HIGHLIGHTED: 'v-tour__target--highlighted',
-    TARGET_RELATIVE: 'v-tour__target--relative'
+  classes: {
+    active: 'v-tour--active',
+    targetHighlighted: 'v-tour__target--highlighted',
+    targetRelative: 'v-tour__target--relative'
   },
-  TRANSITION: 'box-shadow 0s ease-in-out 0s',
-  useKeyboardNavigation: true,
-  startTimeout: 0,
-  stopOnTargetNotFound: true
+  transition: 'box-shadow 0s ease-in-out 0s'
 }
@@ -52,7 +50,23 @@
   enabledButtons: DEFAULT_OPTIONS.enabledButtons,
-  modifiers: {
-    arrow: {
-      element: '.v-step__arrow'
+  modifiers: [
+    {
+      name: 'arrow',
+      options: {
+        element: '.v-step__arrow',
+        padding: 10
+      }
+    },
+    {
+      name: 'preventOverflow',
+      options: {
+        rootBoundary: 'window'
+      }
+    },
+    {
+      name: 'offset',
+      options: {
+        offset: [0, 10]
+      }
     }
-  },
+  ],
   placement: 'bottom'
@@ -59,0 +73,0 @@ }

tests/unit/VTour.spec.js

@@ -1,2 +0,2 @@
-import { mount } from '@vue/test-utils'
+import { mount, shallowMount } from '@vue/test-utils'
 import Vue from 'vue'
@@ -44,3 +44,3 @@ import VueTour from '@/main'
   it('stays within the boundaries of the number of steps', async () => {
-    const wrapper = mount(VTour, {
+    const wrapper = shallowMount(VTour, {
       propsData: {
@@ -113,3 +113,3 @@ name: 'myTestTour',
     it('invokes before() on start()', async () => {
-      const wrapper = mount(VTour, {
+      const wrapper = shallowMount(VTour, {
         propsData: {
@@ -130,3 +130,3 @@ name: 'myTestTour',
     it('invokes before() on nextStep()', async () => {
-      const wrapper = mount(VTour, {
+      const wrapper = shallowMount(VTour, {
         propsData: {
@@ -167,3 +167,3 @@ name: 'myTestTour',
     it('handles before() promise rejection on nextStep()', async () => {
-      const wrapper = mount(VTour, {
+      const wrapper = shallowMount(VTour, {
         propsData: {
@@ -187,3 +187,3 @@ name: 'myTestTour',
     it('handles before() promise rejection on previousStep()', async () => {
-      const wrapper = mount(VTour, {
+      const wrapper = shallowMount(VTour, {
         propsData: {
@@ -190,0 +190,0 @@ name: 'myTestTour',

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

2201943

decreased by-2.81%

Lines of code

13379

decreased by-8%

Dependency changes

• + Added@popperjs/core@^2.9.1

• + Added@popperjs/core@2.11.8(transitive)

• - Removedpopper.js@^1.16.0

• - Removedpopper.js@1.16.1(transitive)

• Updatedvue@^2.6.12