Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

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

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

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.


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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

2 participants