Tour does not support turning off animation

Created on 30 July 2014, over 10 years ago
Updated 13 September 2024, 2 months ago

There doesn't seem to be a way to provide a non-animated tour. Please provide one.

Steps:
1. Go to /admin/structure/views/view/content
2. Click tour
3. Click next

Actual result: Page automatically scrolls as it pops up the next step. There is no way for me to prevent the animation.

Expected result: I have a way to tell Drupal that I don't want it to animate scrolling. Page does not scroll. If the next tour bubble is off the screen an arrow appears to prompt me to scroll.

Technically, this preference belongs on my user page since I would want it to display that behavior site-wide. However, the tour module would need to recognize this setting.

I believe this technically is not required by WCAG 2.0 specs on animation. However, the current behavior would prevent me from taking tours.

The best behavior would be for Tours to respect prefers-reduced-motion. Do not animate if prefers-reduced-motion is set to reduce, in accordance with ๐ŸŒฑ [policy, no patch] Use "prefers-reduced-motion" media query to disable animations Active .

๐Ÿ› Bug report
Status

Fixed

Version

2.0

Component
Tourย  โ†’

Last updated 1 day ago

Created by

๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

Live updates comments and jobs are added and updated live.
  • Accessibility

    It affects the ability of people with disabilities or special needs (such as blindness or color-blindness) to use Drupal.

Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • ๐Ÿ‡ณ๐Ÿ‡ฟNew Zealand quietone

    This extension is being deprecated, see ๐ŸŒฑ [Meta] Tasks to deprecate Tour module Fixed . It will be removed from core and moved to a contrib project, ๐Ÿ“Œ [11.x] [Meta] Tasks to remove Tour Postponed .

    This is now Postponed. The status is set according to two policies. The Remove a core extension and move it to a contributed project โ†’ and the Extensions approved for removal โ†’ policies.

  • ๐Ÿ‡ณ๐Ÿ‡ฟNew Zealand quietone
  • Status changed to Needs work 7 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    So we probably could add a Tour settings page where we turn of the auto scrolling

    Or do some alter hook to the user edit form?

    Thought?

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

    Actually, this issue is probably obsolete. If Tours were to respect prefers-reduced-motion, then there would be no need for a separate setting.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

    It appears that I never filed this with with joyride. I have now filed this as Respect prefers-reduced-motion #241

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States thejimbirch Cape Cod, Massachusetts

    Tours no longer use Joyride. That was deprecated as I believe it is no longer supports.

    Tour now uses the Joyride library. I filed an issue there back in 2021.

    https://github.com/shepherd-pro/shepherd/issues/1652

    It may be possible for this module to add the needed functionality. I am not that much of a JavaScript person to figure that out though.

  • Assigned to smustgrave
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    May have an idea.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave
  • Status changed to Needs review 3 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave
  • Status changed to Needs work 3 months ago
  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    hm in MR48 if "reduce motion" is active on the operating system level (macOS on my end) the scrollTo event is set to false (if i read it correctly). problem with this as illustrated in the video, in some cases the highlighted component the tour tip is referring to is outside the viewport, in one case the highlighted component AND the tour tip is outside the viewport.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    Yes the ticket mentions turning off scrolling.

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    hm but by entirely turning off the scrolling the information is getting lost. if i remember correctly from the other issue you'Ve closed as duplicated you've mentioned that shepherd doesn't have any css animations? is that scrolling entirely javascript based then? is that the reason when the scrollTo is omitted that the focus doesn't just jump? would it be possible to have a progressive enhancement, meaning it just jumps without animation and if the operating system has no preference for the reduced motion media query (@media (prefers-reduced-motion: no-preference)), the animation related parts would become active?

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany
  • Status changed to Needs review 3 months ago
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    Set to auto

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    now it looks like the system settings are minded, see reduce_motion.mp4. Curious what @charles belov thinks about the current MR?

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

    Happy to test on simplytest.me if someone can point me to instrux and a sample tour. Not a developer here, I'm Quality Assurance.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

    Please split the example video into two videos, one with motion and one with the reduce-motion setting. I didn't know what I was getting into and the motion part of the video made my eyes feel ill.

    The non-motion part is likely what I'm seeking, but until my eyes calm down (and you provide a reduced-motion-only video that I can safely watch) I'm not in a position to judge.

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    argh apologies for the video, THAT shouldnt have happened!:( i've followed your suggestion and uploaded two separate files, reduced_motion.mp4 and full_motion.mp4.

    for changing the file name for already uploaded files i see no option. but i'll add a warning to the comment containing the video.

    and in regards of simplytestme i am not sure if it is possible. i've just checked and the tour project isnt found there. i could share a local instance with the MR applied and send the link your way tomorrow if you want to.

    and another time sorry for the oversight with the video :((((

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

    Thank you.

    I've viewed the reduced motion video. It went by a little fast (I wound up watching it at half speed) but I'm able to suss out some comments.

    The question with reduced motion can sometimes be that there was some advantage with the motion that needs to be replaced in a safe way. Here, the point would be that with long pages, it may be hard to tell where you are on the page, and whether you went up or down to get there. This is relevant to a tour, because the visitor needs to be able to replicate the action.

    While your demo video has scroll bars, and I have my scroll bars set to always on, some operating systems (in my case macOS) allow setting the scroll bars to only display when you need them. So people who have that setting may not be able to tell where the particular tour point of interest is on the page. So they trade information for safety.

    I don't want to over-engineer this, but such people might need a brief arrow cue that we are going down the page. Maybe even one arrow for a short distance or three for a long distance. Maybe the arrow would fade in and out.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US
  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    So question is do we merge this or hold on the other feature. I donโ€™t know how long that could take

  • ๐Ÿ‡ฉ๐Ÿ‡ชGermany rkoller Nรผrnberg, Germany

    @charles belov, i am on macos as well, and i also have set safari to always show the scrollbar. but i've just tested with the two other options available "when scrolling" and "automatically based on mouse or trackpad", the scrollbar is shown and rather quickly fades out right after the position changed for the next tour tip. so at least for macos the user would have a certain contextual awareness. but i am not sure how other operating systems handle the showing and hiding of the scrollbar.
    so getting to the question from @smustgrave i wonder if it would make sense to commit the current state of the MR and open a followup issue for the contextual information charles suggested? cuz the module not minding the operating system setting for reduce motion shouldnt be kept up much longer imho?

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave

    If someone can open that follow up will merge it

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States charles belov San Francisco, CA, US

    @rkoller @smustgrave I concur. I would be unable to reproduce the issue, so I am not that one to file the second issue if there's not an easy way to reproduce on the Mac.

  • ๐Ÿ‡บ๐Ÿ‡ธUnited States smustgrave
  • Status changed to Fixed 3 months ago
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024