feat: Add V2 of header actions slot by ChrisChV · Pull Request #682 · openedx/frontend-component-header

ChrisChV · 2026-08-25T00:45:56Z

The showUserDropdown prop gated both the LearningHeaderActionsSlot and the AuthenticatedUserDropdown, making it impossible to hide the user dropdown without also hiding all the action items, and impossible for third-party plugins attached to that slot to render independently of the user dropdown's visibility.

This PR introduces a new org.openedx.frontend.layout.learning_header_actions.v2 slot:

v2 always renders, regardless of showUserDropdown. Use this slot ID for new plugin configurations that should render even when showUserDropdown is false.
v2 wraps the existing v1 slot (notifications tray + help link), which keeps its original behavior unchanged — only rendered when showUserDropdown is true — preserving backwards compatibility for existing consumers of v1.

This PR does not change any default, out-of-the-box visual behavior. With no custom plugin configuration,
the header looks and behaves exactly as it does on main, including with showUserDropdown={false}.
The only thing this PR unlocks is the ability for plugin authors to opt into .v2 so their own widgets render
independently of showUserDropdown.

A follow-up DEPR ticket will propose removing v1 once its default content (notifications tray + help link) can move into v2 unconditionally.

Supporting information

Related issue: Learning Header's user menu slots can't fully hide/replace it. #675
Related PR and discussion: fix: showUserDropdown hiding LearningHeaderActionsSlot #676
DEPR ticket: [DEPR]: Learning Header Actions Slot V1 #681

Testing instructions

Important: Before starting, ensure you have a Tutor environment with the Learning MFE in development mode running.

Clone the repo. From the main branch, run npm ci && npm run build.
From the Learning MFE, run npm install "../path/to/this/repo" --legacy-peer-deps.
Add the following to frontend-app-learning/env.config.jsx to set showUserDropdown: false:

   import { PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

   const hideUserMenu = (widget) => {
    widget.content = {
      ...widget.content,
      showUserDropdown: false,
    };
    return widget;
  };

   export default {
     pluginSlots: {
       'org.openedx.frontend.layout.header_learning.v1': {
         keepDefault: true,
         plugins: [
           {
             op: PLUGIN_OPERATIONS.Modify,
             widgetId: 'default_contents',
             fn: hideUserMenu,
           },
         ],
       },
     },
   };

Add the following to frontend-app-learning/module.config.js:

module.exports = {
  localModules: [
    {
      moduleName: '@edx/frontend-component-header',
      dir: '../frontend-component-header', // adjust this relative to your repo
    },
  ],
};

Run the Learning MFE in dev mode with main checked out on this repo. Confirm that with showUserDropdown: false, the user dropdown, notifications, and "Help" link are hidden (pre-PR behavior).
Switch this repo to this PR's branch and run npm run build
Confirm the header still looks the same as step 5 — no regression.

Introduce a v2 version of LearningHeaderActionsSlot that always mounts, wrapping the existing v1 slot (HeaderNotificationsSlot and LearningHelpSlot) which stays gated behind showUserDropdown. This preserves the v1 slot API contract for existing plugin consumers while allowing new plugins to attach to v2 unconditionally. Note: HeaderNotificationsSlot/LearningHelpSlot remain hidden when showUserDropdown is false. Fully decoupling them from showUserDropdown requires deprecating v1 first, and is left for a follow-up once the DEPR lands.

openedx-webhooks · 2026-08-25T00:46:02Z

Thanks for the pull request, @ChrisChV!

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 · 2026-08-25T00:49:10Z

Codecov Report

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #682      +/-   ##
==========================================
+ Coverage   73.07%   74.56%   +1.49%     
==========================================
  Files          60       61       +1     
  Lines         520      523       +3     
  Branches      110      110              
==========================================
+ Hits          380      390      +10     
+ Misses        137      130       -7     
  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.

arbrandes

Looks great, for the most part! Just a couple of change requests and a few non-blocking nits.

arbrandes · 2026-09-02T13:19:41Z

+        {authenticatedUser && (
        <>
-          <LearningHeaderActionsSlot />
-          <AuthenticatedUserDropdown
-            username={authenticatedUser.username}
-          />
+          <LearningHeaderActionsSlot showUserDropdown={showUserDropdown} />
+          {showUserDropdown && (
+            <AuthenticatedUserDropdown
+              username={authenticatedUser.username}
+            />
+          )}
        </>
        )}


v2 should render for anonymous users.

Hoist the slot out of the authenticatedUser guard, folding the gate into the prop it passes down. Rename that prop while you are there (v2/index.jsx:6): it no longer tracks the dropdown, only whether v1's default contents render.

Suggested change

{authenticatedUser && (

<>

<LearningHeaderActionsSlot />

<AuthenticatedUserDropdown

username={authenticatedUser.username}

/>

<LearningHeaderActionsSlot showUserDropdown={showUserDropdown} />

{showUserDropdown && (

<AuthenticatedUserDropdown

username={authenticatedUser.username}

/>

)}

</>

)}

<LearningHeaderActionsSlot showDefaultActions={showUserDropdown && !!authenticatedUser} />

{authenticatedUser && showUserDropdown && (

<AuthenticatedUserDropdown

username={authenticatedUser.username}

/>

)}

Default output stays identical in all four combinations of the two flags, and .v2 plugins gain the anonymous header.

Anonymous learners do reach this header: frontend-app-learning authenticates no route, and GoalUnsubscribe.jsx, its only caller passing showUserDropdown={false}, is explicitly anonymous-friendly. PageNotFound.jsx and CourseAccessErrorPage.jsx likewise.

Updated: 26b1919

arbrandes · 2026-09-02T13:19:42Z

+- **Notification Tray** (via `HeaderNotificationsSlot`) — Rendered before the help link
+- **Help Link** (via `LearningHelpSlot`)
+
+> **Note:** This slot is only rendered when `showUserDropdown` is `true`. To render content regardless of `showUserDropdown`, use the parent [`v2` slot](../v2/).


v1's docs omit the authenticatedUser gate.

v1 stays gated on both flags, so "only rendered when showUserDropdown is true" needs "and a user is authenticated" here, in LearningHeaderActionsSlot/README.md:6, and in the hierarchy diagram at HeaderNotificationsSlot/README.md:31. v2's own "always renders" wording becomes accurate once the change to LearningHeader.jsx lands.

Updated: 5650a8e

arbrandes · 2026-09-02T13:19:42Z

+  it('hides the user dropdown and the header actions when showUserDropdown is false', () => {
+    render(<Header showUserDropdown={false} />);
+
+    expect(screen.queryByText(authenticatedUser.username)).not.toBeInTheDocument();
+    expect(screen.queryByText('Help')).not.toBeInTheDocument();
+  });


This test passes unchanged on master.

I ran it against the base files and all three cases pass, so it guards pre-existing hiding behavior and covers no new path. Add a case with a widget configured on .v2 and showUserDropdown={false}, asserting the widget appears, plus one for the anonymous case. That needs a mergeConfig({ pluginSlots: { ... } }) setup, which this repo has no precedent for.

Updated: 3ae9441

arbrandes · 2026-09-02T13:19:42Z

 ### Learning Header
 * [`org.openedx.frontend.layout.header_learning_course_info.v1`](./CourseInfoSlot/)
-* [`org.openedx.frontend.layout.learning_header_actions.v1`](./LearningHeaderActionsSlot/)
+* [`org.openedx.frontend.layout.learning_header_actions.v1`](./LearningHeaderActionsSlot/v1/)


v1 is not marked deprecated.

Two lines, here and in v1/README.md, and the DEPR (#681) defers it to a follow-up. Worth doing here so the index does not present both versions as equal choices.

@arbrandes The OEP-21, indicates that it is only marked as deprecated after the plan is approved. That's the reason why I didn't include it. I want to confirm whether you think we should still include it.

arbrandes · 2026-09-02T13:19:42Z

+LearningHeaderActionsSlot.defaultProps = {
+  showUserDropdown: true,
+};


Nit: use a destructuring default instead. React 18.3 deprecates defaultProps on function components, and DesktopSecondaryMenuSlot/v2 declares propTypes only.

Updated: daa487e

arbrandes · 2026-09-02T13:19:42Z

+  <PluginSlot
+    id="org.openedx.frontend.layout.learning_header_actions.v2"
+  >


Nit: pluginProps={{ showUserDropdown }}, as DesktopSecondaryMenuSlot/v2 does for menu. Addable later without a version bump.

Updated: daa487e

arbrandes · 2026-09-02T13:19:42Z

   Notifications appear before secondary menu items (e.g., "New", "Help")

-2. **Learning Header** — via `org.openedx.frontend.layout.learning_header_actions.v1`
+2. **Learning Header** — via `org.openedx.frontend.layout.learning_header_actions.v2` (nests `.v1` — see [LearningHeaderActionsSlot](../LearningHeaderActionsSlot/v2/))


Nit: reads as a direct parent, which it is for the desktop entry above but not here. The parenthetical and the diagram below get it right, so this is cosmetic.

Updated: 5650a8e

…eaderActionsSlot

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 25, 2026

openedx-webhooks added this to Contributions Aug 25, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Aug 25, 2026

This was referenced Aug 25, 2026

[DEPR]: Learning Header Actions Slot V1 #681

Open

fix: showUserDropdown hiding LearningHeaderActionsSlot #676

Closed

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Aug 26, 2026

mphilbrick211 requested a review from a team August 26, 2026 18:51

arbrandes linked an issue Aug 27, 2026 that may be closed by this pull request

Learning Header's user menu slots can't fully hide/replace it. #675

Open

arbrandes requested changes Sep 2, 2026

View reviewed changes

ChrisChV added 4 commits September 3, 2026 20:26

fix: mount LearningHeaderActionsSlot v2 for anonymous users

26b1919

docs: clarify authenticatedUser gate and slot hierarchy for LearningH…

5650a8e

…eaderActionsSlot

test: New tests to cover v2 paths

3ae9441

fix: Nits on the code

daa487e

ChrisChV requested a review from arbrandes September 4, 2026 01:55

Uh oh!

Conversation

ChrisChV commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Supporting information

Testing instructions

Uh oh!

openedx-webhooks commented Aug 25, 2026

Uh oh!

codecov Bot commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ChrisChV commented Aug 25, 2026 •

edited

Loading

codecov Bot commented Aug 25, 2026 •

edited

Loading