Skip to content

feat: more customisability for course outline sidebar, course tabs #1908

Open
xitij2000 wants to merge 5 commits into
openedx:masterfrom
open-craft:kshitij/plugin-slots-exemplar
Open

feat: more customisability for course outline sidebar, course tabs #1908
xitij2000 wants to merge 5 commits into
openedx:masterfrom
open-craft:kshitij/plugin-slots-exemplar

Conversation

@xitij2000
Copy link
Copy Markdown
Contributor

@xitij2000 xitij2000 commented May 2, 2026

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 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
Copy link
Copy Markdown

openedx-webhooks commented May 2, 2026

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 2, 2026
@xitij2000 xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch 3 times, most recently from b7261bd to 801197c Compare May 4, 2026 04:58
@codecov
Copy link
Copy Markdown

codecov Bot commented May 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.40%. Comparing base (7168374) to head (1b58ad3).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1908      +/-   ##
==========================================
+ Coverage   91.29%   91.40%   +0.10%     
==========================================
  Files         343      350       +7     
  Lines        5770     5855      +85     
  Branches     1388     1363      -25     
==========================================
+ Hits         5268     5352      +84     
- Misses        483      484       +1     
  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.


const CourseTabsNavigation = ({
activeTabSlug = undefined,
className = null,
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown

@musaabhasan musaabhasan left a comment

Choose a reason for hiding this comment

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

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.

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

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

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I've fixed this issue.

xitij2000 added 4 commits May 10, 2026 12:22
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.
@xitij2000 xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch from 5c892a2 to 966ee19 Compare May 10, 2026 06:54
…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 xitij2000 force-pushed the kshitij/plugin-slots-exemplar branch from 966ee19 to 1b58ad3 Compare May 11, 2026 19:00
@xitij2000 xitij2000 marked this pull request as ready for review May 12, 2026 16:37
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

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

3 participants