Skip to content

fix: show correct icons in the sidebar for units with custom XBlocks - #36135

Merged
farhaanbukhsh merged 1 commit into
openedx:masterfrom
open-craft:agrendalath/unit-icons-for-custom-xblocks-upstream
Aug 20, 2025
Merged

fix: show correct icons in the sidebar for units with custom XBlocks#36135
farhaanbukhsh merged 1 commit into
openedx:masterfrom
open-craft:agrendalath/unit-icons-for-custom-xblocks-upstream

Conversation

@Agrendalath

Copy link
Copy Markdown
Member

Currently, the sidebar relies only on the XBlock's category class attribute (called type in the transformers). This behavior is inconsistent with the legacy subsection navigation, which relies on the XModuleMixin.get_icon_class method. This commit adds the icon_class to the fields collected by the transformers and uses it to determine whether the "problem" or "video" icon should be displayed for a unit in the sidebar.

Testing instructions

  1. Ensure you have the following Waflle flags (/admin/waffle/flag/) set to "Yes":
    1. courseware.enable_navigation_sidebar
    2. courseware.disable_navigation_sidebar_blocks_caching
  2. Create a new unit with a single HTML block and publish it.
  3. Go to the live version and see that the sidebar icon for this unit is fa-book.
  4. Add an icon_class = 'video' field to the HtmlBlockMixin class (we could use a custom XBlock here, but this is a faster way to test this).
  5. Make any changes to the block you previously created and publish them.
  6. Check the live version again and see that the unit icon is now fa-video.
  7. Add a Problem block to the same unit you've used before and publish it.
  8. Check the live version again and see that the unit icon is now fa-edit.

Private-ref: BB-9332

@Agrendalath Agrendalath self-assigned this Jan 20, 2025
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 20, 2025
@openedx-webhooks

openedx-webhooks commented Jan 20, 2025

Copy link
Copy Markdown

Thanks for the pull request, @Agrendalath!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@farhaanbukhsh farhaanbukhsh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Agrendalath a small nit everything else looks good. Thank you for the amazing work here.

Comment thread lms/djangoapps/course_home_api/outline/serializers.py Outdated
@openedx-webhooks openedx-webhooks added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Aug 20, 2025
Currently, the sidebar relies only on the XBlock's `category` class attribute
(called `type` in the transformers). This behavior is inconsistent with the
legacy subsection navigation, which relies on the `XModuleMixin.get_icon_class`
method. This commit adds the `icon_class` to the fields collected by the
transformers and uses it to determine whether the "problem" or "video" icon
should be displayed for a unit in the sidebar.
@Agrendalath
Agrendalath force-pushed the agrendalath/unit-icons-for-custom-xblocks-upstream branch from 9a55a41 to 9439627 Compare August 20, 2025 16:27
@Agrendalath

Copy link
Copy Markdown
Member Author

@farhaanbukhsh, I squashed the fixup commit, as I had to rebase this branch for the CI anyway.

@farhaanbukhsh farhaanbukhsh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

  • ✅ I tested this with tutor devstack and made sure the icon_class is working.
  • ✅ I read through the code
  • ❌ I checked for accessibility issues
  • ❌ Includes documentation

@farhaanbukhsh
farhaanbukhsh merged commit bbc0cc2 into openedx:master Aug 20, 2025
49 checks passed
@farhaanbukhsh
farhaanbukhsh deleted the agrendalath/unit-icons-for-custom-xblocks-upstream branch August 20, 2025 18:59
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Aug 20, 2025
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

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

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants