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

EDSC-4330: Tour adjustments #1843

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

EDSC-4330: Tour adjustments #1843

wants to merge 7 commits into from

Conversation

dpesall
Copy link
Member

@dpesall dpesall commented Dec 12, 2024

Overview

What is the feature?

  • Adding logic to show the + and buttons on step 8 of the tour which are normally only visible when hovering a collection.
  • Adding a footnote to let users know they can navigate the tour using arrow keys.

What is the Solution?

  • Adding logic to handle the hiding/showing of + and on the first collection for slide 8.
  • Adding a note to let the users know about navigation hotkeys.

What areas of the application does this impact?

  • Search Tour

Testing

Reproduction steps

  1. Start the Tour
  2. Verify that the first slide has a footnote about the users being able to navigate using the arrow keys
  3. Verify that slide 8 which talks about the + and buttons are shown on the first collection in the list.

Attachments

Screenshot 2024-12-11 at 2 21 00 PM
Screenshot 2024-12-12 at 10 05 02 AM

Checklist

  • I have added automated tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.80%. Comparing base (fcae98f) to head (5668a32).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1843      +/-   ##
==========================================
- Coverage   93.81%   93.80%   -0.02%     
==========================================
  Files         777      777              
  Lines       18867    18867              
  Branches     4867     4865       -2     
==========================================
- Hits        17701    17698       -3     
- Misses       1090     1094       +4     
+ Partials       76       75       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@eudoroolivares2016
Copy link
Contributor

Can you add a screenshot of slide 8

@trevorlang trevorlang self-requested a review December 13, 2024 17:45
Copy link
Collaborator

@trevorlang trevorlang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for huddling. Just wanted to document what we talked through on the PR. Thanks for working through these last tweaks 🙌

  • Fix last slide on logged out tour, should be affixed to the log in button
  • Fix css
    • Need to follow bem
    • Need to move the kbd styles
  • Update text on the bottom of the slides to say "Don't show the tour again"
  • Move arrow key text to first slide and tweak language
  • Add "Tip:" text to all "tip" sections
  • Fix spacing on icons on first slide
  • Fix spacing on "Do not show again" on last slide
  • Add aria-labels to all icons. Need to make sure the show tour ? icon has a aria-label.

Copy link
Contributor

@eudoroolivares2016 eudoroolivares2016 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pulled down locally styling looked good appears to me to have addressed feedback

left: calc(100%);
pointer-events: none;
}
// Move these to top level search tour
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unintentional comments, I think

<EDSCIcon
className="align-middle"
icon={ArrowFilledLeft}
aria-label="Left arrow key"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These icons are too large. When we paired, I think I had something like size={10} on them.

<EDSCIcon
className="align-middle"
icon={ArrowFilledRight}
aria-label="Right arrow key"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add size={10} here too

Use
<kbd className="mx-1 align-bottom">
<EDSCIcon
className="align-middle"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Played with this a little more and I think we can get rid of the align-middle class on the icons.

<strong>Tip:</strong>
{' '}
Use
<kbd className="mx-1 align-bottom">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might look better with align-baseline instead of align-bottom

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The search-tour__note class is causing some issues with the size of the icon on the starting slide. We should remove these lines in that class:

display: flex;
align-items: center;


&__text-icon {
display: inline-block;
vertical-align: center;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need vertical-align: middle instead of vertical-align: center here

<EDSCIcon
className="search-tour__text-icon"
icon={FaQuestion}
aria-label="Start Search Tour"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add size={10} to this icon

@eudoroolivares2016 eudoroolivares2016 changed the title EDSC-4330 Tour adjustments EDSC-4330: Tour adjustments Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants