Skip to content

Conversation

@bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Jan 8, 2026

Description

When trying to pull in the newest version of Paragon, some type errors were showing up. I'm fixing some of them in openedx/paragon#4077 but others should be fixed in this repo.

The Paragon Breadcrumb label is used as a key in various places and so should be a string. It also needs to be unique, which seems dumb but that's how it's implemented. So I've changed the container changes preview "Back" breadcrumb from using a paragon icon to using a unicode left arrow:

Before After
before after

The difference is hardly noticeable, but this way it has the correct string type. If we really need the icon, we could just change this to a horizontal Stack instead of a Breadcrumb.

I also fixed some missing i18n for the word "Back", and changed a user-visible message to not include the term "Breadcrumb" which is a technical term that users may not know.

I also changed target to currentTarget in an event handler. For an element with no children, these will always be the same, but with the changes in openedx/paragon#4077 , only currentTarget will have the correct HTMLElement typing required to access data- attributes, because in theory the target value could be a totally different child element.

Supporting information

Together with openedx/paragon#4077 , this will unblock #2765 .

Testing instructions

Check that the "Library Updates" page is working as normal.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

Private ref: MNG-4846

@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @bradenmacdonald.

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.

@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 Jan 8, 2026
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jan 8, 2026
@bradenmacdonald bradenmacdonald force-pushed the braden/breadcrumb-paragon-fixes branch from 8fc7201 to b25ed91 Compare January 8, 2026 23:09
@codecov
Copy link

codecov bot commented Jan 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.99%. Comparing base (4787490) to head (b25ed91).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2811   +/-   ##
=======================================
  Coverage   94.99%   94.99%           
=======================================
  Files        1256     1256           
  Lines       28800    28800           
  Branches     6337     6337           
=======================================
  Hits        27358    27358           
  Misses       1384     1384           
  Partials       58       58           

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

@ChrisChV
Copy link
Contributor

ChrisChV commented Jan 9, 2026

@bradenmacdonald The code looks good! But, in my instance, the change is noticeable:

image

@navinkarkera
Copy link
Contributor

@bradenmacdonald Yes, it looks a bit weird. The unicode arrow looks small.

@bradenmacdonald
Copy link
Contributor Author

@ChrisChV @navinkarkera Weird, I wonder why it's so different for you guys. I thought with web fonts these days, things would be more consistent than that. How about I just change it to not use Breadcrumb at all then? Just having a "back" button may not really be a proper usage of breadcrumb anyways (?) A horizontal stack will work just as well.

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.

4 participants