Problem/Motivation

At the moment the only way to start a tour is either click the tour button with the mouse cursor or navigate to the button with the keyboard. Plus screenreader users have to navigate to the tour button until to find out if there is a tour available for a page or not.

Steps to reproduce

Proposed resolution

It might be helpful for advanced users and screenreader users in particular to add a hot key for starting a tour. That way if a screenreader user gets to a page and presses the hot key either the tour starts immediately or you could add an announcement, something like that there is no tour for this page available. That way there is no need to get to the "start tour"-button and the entire process is streamlined. In regards of the hotkey it should be avoided to have a single character key shortcut like gmail has which could cause problems. having a non printable keyboard key like CTRL or ALT is advisable ( https://dequeuniversity.com/resources/wcag2.1/2.1.4-character-key-shortcuts)

Remaining tasks

User interface changes

API changes

Data model changes

Issue fork tour-3469297

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

rkoller created an issue. See original summary.

smustgrave’s picture

smustgrave commented

Suggested keys? control + ?

I use control + t often so against that.

smustgrave’s picture

smustgrave commented

Control alt t

Maybe? I don’t use hot keys often put implementation doesn’t seem bad

rkoller’s picture

rkoller
he/him
Primary language German
Location Nürnberg, Germany
commented

at the moment the only hotkey i know in the context of drupal is the one set by the coffee module (alt d). so maybe using the alt key in combination with "t" might be an option? i just dont like something like control and alt. plus that might cause conflicts on the mac with voiceover. the voiceoverkey is ctrl + alt.

and hotkeys might be something that could be improved for drupal core in general. something i've noticed in the competitive review where we took a look at different CMSes in the context of a11y and the features they have. joomla for example has a directly accessible hotkey menu listing the most important keyboard shortcuts. quite handy.

smustgrave opened merge request !67

smustgrave’s picture

smustgrave commented
Status: Active » Needs review

Like this?

rkoller’s picture

rkoller
he/him
Primary language German
Location Nürnberg, Germany
commented

nice looks good! one potential problem, one that the coffee module has as well and another unrelated observation.

the problem the coffee module has is how do people discover the actual hotkey (that one is in place)? like the tour module the coffee module also has a top level menu item. but that the coffee module has a hotkey can easily be missed. i'Ve missed and overread that fact on the project page for a long long time. so i wonder would it make sense for one to also add a note about the hotkey to the project description of the tour module on d.o anyway (some people actual read that thoroughly) but i also wonder if it would make sense to add one tip to one of the tours informing the user? maybe not in the tours tour which is only about the tour admin interface but on a tour people use for onboarding? not sure what the best place would be tbh.

and on unrelated note. i've noticed i am able to jump between tour tips by pressing the arrow left and arrow right key? that was sort of unexpected. there is no indication nor visual feedback in the ui. the tip just changes. but i am also unsure how you could indicate that button press and change? (but out of the scope for this issue even unsure if it is worth an issue right now. it was just unexpected and everything looks so static "arrowing" through the tip with no feedback except the new highlights and text)

smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work
Issue tags: +tour-2.0.5-target

Do need test coverage

smustgrave’s picture

smustgrave commented
Assigned: Unassigned » smustgrave
smustgrave’s picture

smustgrave commented

Definitely think we can add a note in the README and project page.

If the arrows are working for next/previous that's probably a shepherd feature because I don't see anything on our side that would do this.

smustgrave’s picture

smustgrave commented
Status: Needs work » Needs review

If that description looks good I'll add to the project page.

I'm skipping tests for this one as I can't figure it out and too frustrated trying haha.

smustgrave’s picture

smustgrave commented

If the wording works we can merge this one.

rkoller’s picture

rkoller
he/him
Primary language German
Location Nürnberg, Germany
commented
Status: Needs review » Reviewed & tested by the community

Looks like you've used my suggestion as is, so for my end no complaints.

smustgrave’s picture

smustgrave commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

ressa’s picture

ressa
he/him
commented
Related issues: +#3317002: Access search field via a keyboard shortcut with accesskey, +#3478254: Add a hotkey to start the token browser

Nice solution with the shortcut @smustgrave! And thanks @rkoller for making me aware of it in the related Token issue. I may create a follow up issue for Admin Toolbar Search, based on that method ...