feat: more customisability for course outline sidebar, course tabs by xitij2000 · Pull Request #1908 · openedx/frontend-app-learning

xitij2000 · 2026-05-02T04:20:51Z

This PR does a couple of things:

It adds slots to allow customsing the tab bar, and elements of the course outline.
It refactors the course outline so that the outline component can be used outside of a sidebar, the aim being to pull that component out into a different slot and show it at a different place.
It generally makes the course outline more customisable via CSS variables.
It converts all the touched code to TypeScript

openedx-webhooks · 2026-05-02T04:20:56Z

Thanks for the pull request, @xitij2000!

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.

codecov · 2026-05-04T09:18:56Z

Codecov Report

❌ Patch coverage is 95.77465% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.33%. Comparing base (cfc91c3) to head (5db75dc).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/courseware/course/sequence/Sequence.jsx	25.00%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1908      +/-   ##
==========================================
+ Coverage   91.30%   91.33%   +0.03%     
==========================================
  Files         344      353       +9     
  Lines        5774     5877     +103     
  Branches     1351     1401      +50     
==========================================
+ Hits         5272     5368      +96     
- Misses        483      490       +7     
  Partials       19       19

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

xitij2000 · 2026-05-05T13:06:40Z


 const CourseTabsNavigation = ({
  activeTabSlug = undefined,
-  className = null,


This is only used in one place and it doesn't send this param, so it can be removed.

xitij2000 · 2026-05-05T13:11:44Z

@brian-smith-tcril Here is the PR I mentioned during the discussion on the conference talk. There may still be changes based on how well it's working out.

musaabhasan

One small documentation/runtime mismatch stood out while reviewing the new plugin slot surface. It is worth fixing before the PR leaves draft because downstream plugin authors are likely to copy the slot ID directly from the README.

musaabhasan · 2026-05-09T18:11:58Z

@@ -0,0 +1,38 @@
+# Course Tab Navigation Slot
+
+### Slot ID: `org.openedx.frontend.learning.course_tab_navigation.v1`


This documented slot ID does not match the implementation in CourseTabsNavigationSlot/index.tsx, which registers org.openedx.frontend.learning.course_tabs_navigation.v1 with tabs plural. Any env.config.jsx copied from this README would silently target the wrong slot and fail to customize the course tab navigation. Please align the README header and example key with the implemented ID, or rename the implementation if the singular ID is intended.

Thanks! I've fixed this issue.

farhaanbukhsh

@xitij2000 Thank you for the amazing work. I have highlighted few nits also please fix the CI. I have done a pass on the code and it looks good. Will test it once.

farhaanbukhsh · 2026-05-17T11:18:37Z

+## Example
+
+### Replaced with a custom component
+![custom progress display for section](./course-outline-section-completion-icon.png)


please highlight the slot in the screenshot

I am not sure what you mean by highlight. Adding any visual overlay would be confusing since you don't know if it's part of the UI change or applied on top.

something like a red square pointing out what exactly is the slot 😅

That could also imply that the slot is applying that style.
I'm updating the image by showing a before and after so that the difference is highlighted by contrast.

arbrandes · 2026-05-18T21:50:38Z

-    border: 1px solid #d7d3d1;
+    border-width: var(--learning-sidebar-outline-heading-wrapper-border-width, 1px);
+    border-style: solid;
+    border-color: var(--learning-sidebar-outline-heading-wrapper-border-color, var(--pgn-color-light-700));


See discussion in the forums about this (and the other) variables proposed here:

https://discuss.openedx.org/t/frontend-extensibility-discussion-documenting-best-practices/19055/6?u=arbrandes

farhaanbukhsh

This looks great, @xitij2000 I think what makes this PR stronger is adding testing instructions with a dummy env.config.jsx file.

Adds a new plugin slot (`CourseTabsNavigationSlot`) to enable customization, modification, or hiding of the course tab navigation. Updated relevant components to integrate with the new slot.

Splits `useCourseOutlineSidebar` into `useCourseOutlineData` and `useCourseOutlineSidebar` for improved separation of responsibilities. Updates components and styles to reflect this change. This change allows the usage of the course outline outside of a sidebar context.

…ce completion icons Introduces `CourseOutlineSidebarSectionCompletionIconSlot` and `CourseOutlineSidebarSequenceCompletionIconSlot` to enable customization, modification, or replacement of completion icons in the course outline. Updated components to integrate with these new slots.

Introduces `CourseOutlineSidebarUnitIconSlot` to enable customization, modification, or replacement of unit icons in the course outline sidebar. Refactors `UnitIcon` to support TypeScript and updates related components to integrate with the new slot.

…ng customization Replaces hardcoded styles with CSS variables to enable flexible theming and dynamic styling of the course sidebar components. Adjusts related JSX and SCSS for consistency.

…r heading customization Introduces a new plugin slot (`CourseOutlineSidebarHeadingSlot`) to support customization of the course outline sidebar heading. Refactors existing header logic into a reusable `CourseOutlineHeading` component for better modularity and integration with the new slot.

…vigation Introduces a new plugin slot (`SequenceBottomNavigationSlot`) for extending or replacing the default bottom navigation in course sequences. Updates `Sequence` component to integrate with this slot. Includes documentation and examples for plugin usage.

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels May 2, 2026

openedx-webhooks added this to Contributions May 2, 2026

github-project-automation Bot moved this to Needs Triage in Contributions May 2, 2026

xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch 3 times, most recently from b7261bd to 801197c Compare May 4, 2026 04:58

xitij2000 commented May 5, 2026

View reviewed changes

musaabhasan reviewed May 9, 2026

View reviewed changes

xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch 2 times, most recently from 966ee19 to 1b58ad3 Compare May 11, 2026 19:00

xitij2000 marked this pull request as ready for review May 12, 2026 16:37

xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch from 3caad2f to 864ae87 Compare May 15, 2026 11:42

farhaanbukhsh requested changes May 17, 2026

View reviewed changes

xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch 2 times, most recently from a9cf3b2 to 7b12566 Compare May 18, 2026 15:09

arbrandes reviewed May 18, 2026

View reviewed changes

farhaanbukhsh reviewed May 22, 2026

View reviewed changes

xitij2000 added 6 commits May 23, 2026 09:38

feat: Introduce slot for customizing course tab navigation

8d2679d

Adds a new plugin slot (`CourseTabsNavigationSlot`) to enable customization, modification, or hiding of the course tab navigation. Updated relevant components to integrate with the new slot.

refactor: Enhance course outline sidebar with CSS variables for styli…

ef36142

…ng customization Replaces hardcoded styles with CSS variables to enable flexible theming and dynamic styling of the course sidebar components. Adjusts related JSX and SCSS for consistency.

xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch 2 times, most recently from eaff289 to cf4bdc3 Compare May 23, 2026 06:18

refactor: Remove unused CSS variables from course outline sidebar styles

5db75dc

xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch from cf4bdc3 to 5db75dc Compare May 23, 2026 07:29

		@@ -0,0 +1,38 @@
		# Course Tab Navigation Slot

		### Slot ID: `org.openedx.frontend.learning.course_tab_navigation.v1`

Conversation

xitij2000 commented May 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openedx-webhooks commented May 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

musaabhasan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

farhaanbukhsh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

farhaanbukhsh left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

xitij2000 commented May 2, 2026 •

edited

Loading

openedx-webhooks commented May 2, 2026 •

edited

Loading

codecov Bot commented May 4, 2026 •

edited

Loading