Skip to content

feat: support target and rel on studio header menu items - #687

Open
jacobo-dominguez-wgu wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:open-in-new-tab
Open

jacobo-dominguez-wgu wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:open-in-new-tab

Conversation

@jacobo-dominguez-wgu

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Studio header menu items can now set target and rel, so a link like Roles and Permissions can open in a new tab instead of reloading the current one. This is the first part of openedx/frontend-app-authoring#3052. A follow-up in frontend-app-authoring will set target: '_blank' on that item.

Part of openedx/frontend-app-authoring#3052

Changes

  • NavDropdownMenu exports a NavDropdownMenuItem type with optional target (any anchor target, e.g. _blank or a named tab) and rel. HeaderBody uses this type for mainMenuDropdowns items, so StudioHeader callers can set both fields.
  • The desktop dropdown (NavDropdownMenu) and the mobile menu (MobileMenu) pass these through via a shared getItemLinkProps helper in utils.ts. When target is _blank and no rel is given, the helper sets rel to noopener noreferrer. Items without target render exactly as before.
  • MobileMenu is converted from propTypes to TypeScript, so its items are typed the same way as the desktop dropdown's.
  • Adds @testing-library/user-event as a dev dependency for the new tests.

Why

target/rel are passed straight through, instead of an openInNewTab boolean, so callers can use any target value without another API change.

Testing

  • npm run types (tsc --noEmit) and ESLint pass.
  • All 39 studio-header Jest tests pass. New tests cover: no target, _blank with the default rel, a custom rel, a named target, and the mobile menu applying the same rules.
  • Manual check in the example app (npm start): add target: '_blank' to a mainMenuDropdowns item and confirm it opens in a new tab on desktop and on mobile (window narrower than 842px).

AI disclosure

Created with the assistance of claude opus

@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 Nov 5, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @jacobo-dominguez-wgu!

This repository is currently maintained by @openedx/committers-frontend.

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.

@codecov

codecov Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.48%. Comparing base (922e367) to head (7f31a48).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #687      +/-   ##
==========================================
+ Coverage   74.43%   74.48%   +0.04%     
==========================================
  Files          61       61              
  Lines         528      529       +1     
  Branches      111      111              
==========================================
+ Hits          393      394       +1     
  Misses        132      132              
  Partials        3        3              

☔ View full report in Codecov by Harness.
📢 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.

Menu items in mainMenuDropdowns can now set `target` (any anchor target,
e.g. `_blank`) and `rel`. The desktop dropdown (NavDropdownMenu) and the
mobile menu (MobileMenu) both pass them through via a shared
getItemLinkProps helper, which defaults `rel` to `noopener noreferrer`
when `target` is `_blank` and no `rel` is given. Items without `target`
render as before.

MobileMenu is converted from propTypes to TypeScript so its items share
the NavDropdownMenuItem type.

Adds @testing-library/user-event as a dev dependency for the new tests.

Part of openedx/frontend-app-authoring#3052
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.

2 participants