Skip to content

feat: Add slot for customizing course outline sidebar unit icons#1919

Open
xitij2000 wants to merge 1 commit into
openedx:masterfrom
open-craft:kshitij/course-outline-sidebar-unit-icon-slot
Open

feat: Add slot for customizing course outline sidebar unit icons#1919
xitij2000 wants to merge 1 commit into
openedx:masterfrom
open-craft:kshitij/course-outline-sidebar-unit-icon-slot

Conversation

@xitij2000
Copy link
Copy Markdown
Contributor

Introduces CourseOutlineSidebarUnitIconSlot to enable customization, modification, or replacement of unit icons in the course outline sidebar.

@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 27, 2026
@openedx-webhooks
Copy link
Copy Markdown

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.

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/course-outline-sidebar-unit-icon-slot branch from bf4996f to 1c07116 Compare May 27, 2026 10:34
@codecov
Copy link
Copy Markdown

codecov Bot commented May 27, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1919      +/-   ##
==========================================
+ Coverage   91.30%   91.31%   +0.01%     
==========================================
  Files         344      345       +1     
  Lines        5774     5783       +9     
  Branches     1351     1385      +34     
==========================================
+ Hits         5272     5281       +9     
  Misses        483      483              
  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.

@brian-smith-tcril
Copy link
Copy Markdown
Contributor

This feels very narrowly scoped, and I'm thinking it might make more sense to have a slot that contains the entire unit link instead of just the icon. Then instead of replacing UnitIcon with CourseOutlineSidebarUnitIconSlot in SidebarUnit we could replace SidebarUnit with SidebarUnitSlot in SidebarSequence.

@xitij2000
Copy link
Copy Markdown
Contributor Author

@brian-smith-tcril The reason I kept is narrow is that making it broader would also kind of freeze a larger part of the props as API. However, I understand that just the icons would be too narrow.

I'll look into changing this. I have some time off coming up next week so might only be able to fully look into and and wrap it up after I return.

@brian-smith-tcril
Copy link
Copy Markdown
Contributor

It's probably worth talking through the possible options here. I'd like to find a good balance between "this does everything people could possibly want when customizing the unit links in the sidebar" and "this locks us in to way too many pluginProps."

The ideas that come to mind for me are:

  • Just wrap the icon
    • Not flexible enough, what if someone wants to change the text?
  • Wrap the entire thing
    • Possibly requires too many plugin props
  • Wrap what's inside UnitLinkWrapper
    • The existing styling baked in to UnitLinkWrapper itself might make it hard to use
  • Refactoring to split the visual aspects of SidebarUnit and UnitLinkWrapper out from the functional aspects to provide visual flexibility without exposing all the functional aspects as plugin props
    • Might be complicated, not sure what a good shape would be for that

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