shipshapecode / shipshapecode/vue-shepherd

Guidance on beforeShowPromise and placing tour steps in Vuex Module ?

Open
#35 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Vue
Stars
340
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Hello,

Currently working on a scenario where I would like to take my tour steps our of the main App.vue code and place them in a separate file in order to make code easier to maintain/manage based on modular architecture.

I'm currently using VUEX for the project, so wanted to try and create a guidedtour module and add my steps in there, however I also use the beforeShowPromise in order to change up the UI for the tour steps, make sure options are Visible prior to guiding users through those steps.

Does anyone have any good guidance on best practices to be able to excise the tour steps, and yet still use the beforeShowPromise to reference the vue instance and be able to change variables / layout on the main apps variables ?

How can we get the promise to reference a this. / self of the vue app instance when defined in a separate module.
Appreciate any pointers, examples.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with App.vue and the Vuex guidedtour module described in the issue; trace how beforeShowPromise needs to reference the Vue instance and UI variables. Done means providing guidance or an example for keeping tour steps outside App.vue while still changing the application UI.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.