Skip to content
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.

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

Overhaul of IntroJS #965

Closed
jacobwod opened this issue Dec 17, 2021 · 0 comments
Closed

Overhaul of IntroJS #965

jacobwod opened this issue Dec 17, 2021 · 0 comments
Assignees
Labels
focus:accessibility needs discussion new feature Request for adding/changing functionality
Projects
Milestone

Comments

@jacobwod
Copy link
Member

It's been a couple of years since the initial addition of IntroJS onboarding guide in Hajk (see #398).

This feature has always been behind an experimental flag - for a good reason. I had a feeling that the implementation has its' limitations: no ability to control the guide via Admin UI, no per-map setting - those are only two of many inconveniences.

Halmstad has taken a closer look into this and our focus group proposes the following changes:

  • We must distinguish between features of Hajk itself and the contents of current map. Hajk features are best presented within IntroJS, but a About this map window (part of the Information plugin currently) is also very useful - perhaps even more so than showing users where the search bar is located. Therefore we think that the rendering order should be changed:
    • If Information is to be shown, show it first. Let us present the map's contents.
    • At the end of the Information window there should be an option that allows user to start a guided tour (IntroJS). If user clicks this, the Information window is closed and IntroJS does its' job, pretty much as it does currently.
    • The IntroJS tool (which should either be transformed into a plugin or made a part of core) is available as a Control button, perhaps using the question mark as an icon. This way the user has an option to always start the guided tour.
  • The IntroJS starting window could display more information, something that let's user know that "you will now be taken on a guided tour of this web map solution".
  • We probably shouldn't start with IntroJS visible ever (even if it can remain an Admin UI setting). Our focus group has concluded that if we should start with something visible in front of the map it should be the Information window with clear and concise text introducing the user to the map's contents.

One aspect that needs to be taken into consideration here is when and how the #284 Cookie notice should be shown. We can't have any race conditions here. Hence, this must be done in coordination with #939.

@jacobwod jacobwod added needs discussion new feature Request for adding/changing functionality labels Dec 17, 2021
@jacobwod jacobwod added this to the 3.x milestone Dec 17, 2021
@jacobwod jacobwod self-assigned this Dec 17, 2021
@jacobwod jacobwod added this to Approved ideas in Hajk via automation Dec 17, 2021
@jacobwod jacobwod moved this from Approved ideas to In progress in Hajk Mar 30, 2022
jacobwod added a commit that referenced this issue Mar 30, 2022
- Moved the settings for Introduction from appConfig to mapConfig.
- Removed the 'experimental' flag on those properties.
- Added basic validation of supplied 'steps', with a fallback to defaults if parsing fails.
jacobwod added a commit that referenced this issue Mar 31, 2022
- Removed legacy experimental flags from appConfig.json
- Added new flags to simpleMapConfig.json
jacobwod added a commit that referenced this issue Mar 31, 2022
- #965 introduces breaking changes (deprecated experimental flags), so it's good to mark this as a new beta.
@jacobwod jacobwod modified the milestones: 3.x, 3.10 Mar 31, 2022
@jacobwod jacobwod moved this from In progress to Done in Hajk Mar 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus:accessibility needs discussion new feature Request for adding/changing functionality
Projects
Hajk
  
Done
Development

No branches or pull requests

1 participant