Skip to content

Conversation

@wgu-jesse-stewart
Copy link
Contributor

@wgu-jesse-stewart wgu-jesse-stewart commented Jun 2, 2025

Fixes #1695
Related PR: openedx/frontend-lib-special-exams#164
Summary:
When content within a sequence is shorter than the height of the browser viewport, the .sequence-container > .outline-sidebar-wrapper element does not expand appropriately. This causes the course outline sidebar to be partially or completely hidden from view.

Steps to Reproduce:

Open a course sequence that contains very little content (e.g., a short paragraph or notice).

View the course in a tall browser window.

Observe that the sidebar navigation is cut off or hidden.

Expected Behavior:

The sidebar should remain fully visible and accessible, regardless of the amount of content in the main pane.

Actual Behavior:
When the content is short, the parent container height collapses to fit that content, which in turn restricts the sidebar’s height, hiding part of the navigation.

Screenshots:
image
image

Removing unnecessary wrapper divs and adding some very specific CSS to target the layout parent.

Demo of fix:
https://github.com/user-attachments/assets/627061e0-bb17-459e-af57-fb9a5c1175a9

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

openedx-webhooks commented Jun 2, 2025

Thanks for the pull request, @wgu-jesse-stewart!

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.

Details
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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 2, 2025
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Jun 2, 2025
@codecov
Copy link

codecov bot commented Jun 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.44%. Comparing base (a1d0aff) to head (18a7c3a).
Report is 9 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1724      +/-   ##
==========================================
+ Coverage   90.42%   90.44%   +0.02%     
==========================================
  Files         344      344              
  Lines        5785     5801      +16     
  Branches     1348     1395      +47     
==========================================
+ Hits         5231     5247      +16     
+ Misses        537      535       -2     
- Partials       17       19       +2     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@wgu-jesse-stewart wgu-jesse-stewart requested a review from Copilot June 2, 2025 18:11
@wgu-jesse-stewart wgu-jesse-stewart marked this pull request as draft June 2, 2025 18:11

This comment was marked as outdated.

@wgu-jesse-stewart wgu-jesse-stewart marked this pull request as ready for review June 2, 2025 19:55
@wgu-jesse-stewart wgu-jesse-stewart added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Jun 2, 2025
@wgu-jesse-stewart wgu-jesse-stewart moved this from Done to Ready for Review in Contributions Jun 2, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request fixes the full-height layout issue for the course sequence sidebar by adjusting CSS rules and refining component structure. Key changes include:

  • Updating CSS to use new viewport height units and a revised flex layout.
  • Removing an unnecessary wrapper div in the NoticesProvider component.
  • Refactoring the layout structure in Sequence.jsx to separate the SequenceExamWrapper and CourseLicense components.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/index.scss Updated CSS with new 100svh unit and added #main-content flex styling to improve layout responsiveness.
src/generic/notices/NoticesProvider.jsx Removed an unnecessary wrapper div for clearer component rendering.
src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTray.scss Removed overflow and absolute positioning styling to support the new sidebar layout.
src/courseware/course/sequence/Sequence.jsx Adjusted the component structure to reallocate layout responsibilities between SequenceExamWrapper and CourseLicense.
Comments suppressed due to low confidence (2)

src/courseware/course/sidebar/sidebars/course-outline/CourseOutlineTray.scss:3

  • Removing the 'overflow: auto' property may lead to issues if the sidebar content exceeds the available space, causing potential overflow. Consider verifying that this change does not negatively impact the usability of longer navigation lists or apply a conditional overflow handling.
-    overflow: auto;

src/courseware/course/sequence/Sequence.jsx:233

  • Moving the CourseLicense component outside of the flex container may affect the intended alignment and spacing within the sequence layout. Please confirm that this change meets the layout requirements across different content scenarios.
        <CourseLicense license={license || undefined} />

Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Nice work, thanks for addressing the feedback!

In addition to the inline question, can you please bump frontend-lib-special-exams to ^4.0.0 in package.json?

Copy link
Contributor

@arbrandes arbrandes 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 bearing with me! Approved!

@arbrandes arbrandes merged commit ab3f5fd into openedx:master Jun 6, 2025
7 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jun 6, 2025
@wgu-jesse-stewart
Copy link
Contributor Author

Thanks for bearing with me! Approved!

Absolutely! 🤜🤛 Thanks for helping me get these merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

sequence-container > outline-sidebar-wrapper height is set by sequence height, hiding navigation when content is short

4 participants