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

feat: close sidebar on mobile after selecting a unit #1583

Conversation

Agrendalath
Copy link
Member

@Agrendalath Agrendalath commented Feb 10, 2025

Description

When a user selects a unit on the course outline sidebar, it remains open. This behavior can be confusing on mobile devices because the sidebar is displayed on the entire screen. This PR changes the behavior to close the sidebar once the learner selects the unit.

Testing instructions

  1. Ensure you have enabled the courseware.enable_navigation_sidebar Waffle flag.
  2. Open any course unit on a mobile device.
  3. Open the sidebar on the left side.
  4. Select any unit and check that the sidebar was closed afterward.

Private-ref: BB-334 (temporary)

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 10, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 10, 2025

Thanks for the pull request, @Agrendalath!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.66%. Comparing base (fca32ae) to head (661a3ac).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1583   +/-   ##
=======================================
  Coverage   84.65%   84.66%           
=======================================
  Files         332      332           
  Lines        5683     5685    +2     
  Branches     1359     1360    +1     
=======================================
+ Hits         4811     4813    +2     
  Misses        855      855           
  Partials       17       17           

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

@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Feb 13, 2025
@bradenmacdonald
Copy link
Contributor

Makes sense to me! If you haven't already, can you just get a +1 from some product person, perhaps by asking on Slack #studio ?

@Agrendalath
Copy link
Member Author

@bradenmacdonald, I posted a request on the #wg-product-core channel, as I couldn't find anything closer to the Learning MFE. Do you suggest posting it on the #studio channel, too?

@crathbun428
Copy link

crathbun428 commented Feb 18, 2025

Thank you for catching. This updated behavior makes sense to me.

@itsjeyd itsjeyd added product review PR requires product review before merging product review complete PR has gone through product review and removed product review PR requires product review before merging labels Feb 19, 2025
@itsjeyd itsjeyd added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Feb 27, 2025
@itsjeyd
Copy link

itsjeyd commented Feb 27, 2025

@Agrendalath Friendly nudge to resolve conflicts here.

@Agrendalath
Copy link
Member Author

Agrendalath commented Feb 27, 2025

@itsjeyd, I'll do this in the next sprint, as the rebase will require manual changes and re-testing after the refactor from #1586, which moved the related code around the repo.

@marcotuts
Copy link

+100 to this, I just tested this on the sandbox and it makes general movement between units difficult without this fix! I knew this context and PR and still found myself confused only to remember that's what I was testing / checking :) 👍

@Agrendalath Agrendalath force-pushed the agrendalath/close-sidebar-on-mobile-after-selecting-unit-upstream branch from 89b24cf to 661a3ac Compare March 3, 2025 21:02
@Agrendalath
Copy link
Member Author

@itsjeyd, done.

@bradenmacdonald, could you please merge this?

@bradenmacdonald bradenmacdonald merged commit 2235737 into openedx:master Mar 3, 2025
7 checks passed
@openedx-webhooks openedx-webhooks removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Mar 3, 2025
@Agrendalath Agrendalath deleted the agrendalath/close-sidebar-on-mobile-after-selecting-unit-upstream branch March 3, 2025 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U product review complete PR has gone through product review
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants