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

Sticky side navigation improvements #8947

Merged
merged 1 commit into from
Dec 17, 2021

Conversation

MisRob
Copy link
Member

@MisRob MisRob commented Dec 17, 2021

Summary

This was originally fix for #8627. However, it seem that due to recent changes, behavior of the whole page is now different in regards to what is displayed at certain breakpoints and the problematic constellation of elements might be gone for now. or I wasn't able to find new conditions to reproduce it. However, I thought it might be good to submit the work, since it accounts for more scenarios in regards to hidden/visible top bar and also helped with jumping side navigation due to previously frequent styles updates.

Reviewer guidance

Go to Library, select a channel, and scroll the page - it should scroll at first but as soon as the header is not visible, the side navigation should stick to the top of the page so that it's whole area is visible. It shouldn't get stuck or jump. Please test for more screen resolutions.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

Copy link
Contributor

@sairina sairina left a comment

Choose a reason for hiding this comment

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

Manual testing shows the appropriate behavior for the side nav

} else {
this.stickyTop = '64px';
}
const header = this.$refs.header;
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the difference between using the header ref above as compared to the original: let header = document.getElementsByClassName('header')[0]?

Copy link
Member

Choose a reason for hiding this comment

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

let header = document.getElementsByClassName('header')[0] seems like a riskier reference, as it could pick up a header class from anywhere in the DOM, whereas this will get the header specifically in this component.

Copy link
Member

Choose a reason for hiding this comment

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

(also let is unnecessary unless we are intending to reassign the header variable later)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I made those changes to make things a bit safer in that regards.

@rtibbles rtibbles merged commit 996a24e into learningequality:release-v0.15.x Dec 17, 2021
@MisRob MisRob deleted the side-panel-fix branch January 6, 2022 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants