Skip to content

Art3mi x feat sticky step #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: feat: add theme
merged 4 commits into from
Mar 27, 2021
Merged

Art3mi x feat sticky step #175

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee50e46
Feat: add sticky steps to allow targetless steps
Oct 26, 2018
9967a9b
Merge branch 'feat-sticky-step' of https://github.com/Art3miX/vue-tou…
mmorainville Mar 26, 2021
1777d08
feat: add sticky step
mmorainville Mar 27, 2021
7850f0b
chore: fix indentation
mmorainville Mar 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 43 additions & 18 deletions src/components/VStep.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<template>
<div class="v-step" :id="'v-step-' + hash" :ref="'v-step-' + hash">
<div v-bind:class="{ 'v-step--sticky': isSticky }" class="v-step" :id="'v-step-' + hash" :ref="'v-step-' + hash">
<slot name="header">
<div v-if="step.header" class="v-step__header">
<div v-if="step.header.title" v-html="step.header.title"></div>
Expand Down Expand Up @@ -95,6 +95,12 @@ export default {
...{ enabledButtons: Object.assign({}, this.enabledButtons) },
...this.step.params // Then use local step parameters if defined
}
},
/**
* A step is considered sticky if it has no target.
*/
isSticky () {
return !this.step.target
}
},
methods: {
Expand All @@ -103,23 +109,27 @@ export default {
console.log('[Vue Tour] The target element ' + this.step.target + ' of .v-step[id="' + this.hash + '"] is:', this.targetElement)
}

if (this.targetElement) {
this.enableScrolling()
this.createHighlight()

/* eslint-disable no-new */
new Popper(
this.targetElement,
this.$refs['v-step-' + this.hash],
this.params
)
if (this.isSticky) {
document.body.appendChild(this.$refs['v-step-' + this.hash])
} else {
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)
if (this.stopOnFail) {
this.stop()
if (this.targetElement) {
this.enableScrolling()
this.createHighlight()

/* eslint-disable no-new */
new Popper(
this.targetElement,
this.$refs['v-step-' + this.hash],
this.params
)
} else {
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)
if (this.stopOnFail) {
this.stop()
}
}
}
},
Expand Down Expand Up @@ -198,10 +208,25 @@ export default {
color: white;
max-width: 320px;
border-radius: 3px;
filter: drop-shadow(0 0 2px rgba(0, 0, 0, 0.5));
box-shadow: rgba(0, 0, 0, 0) 0px 0px 0px 0px,
rgba(0, 0, 0, 0) 0px 0px 0px 0px,
rgba(0, 0, 0, 0.1) 0px 4px 6px -1px,
rgba(0, 0, 0, 0.06) 0px 2px 4px -1px;
padding: 1rem;
pointer-events: auto;
text-align: center;
z-index: 10000;

&--sticky {
position: fixed;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);

& .v-step__arrow {
display: none;
}
}
}

.v-step .v-step__arrow {
Expand Down