Introduce courseNavigationBar on header slot by diana-villalvazo-wgu · Pull Request #106 · openedx/frontend-base

diana-villalvazo-wgu · 2025-10-15T23:52:39Z

Description

As part of the conversion of MFEs to frontend base, we figured it out that 3 different repos will need Course Navigation Bar (Learning, Discussions and Instructor), so instead of having repetitive code on 3 different repos we come up with the following approach:

Moving Course Navigation Tab bar to frontend-base as a slot inside the header and adding the roles where this new slot will be active.
We need to get courseId (now we are grabbing it from current location) and make a request using react-query to gather correct course metadata (contains tabs info).
We added an slot for extra content in case MFE needs to add it (current use case: Learning MFE, courseware search).

Screenshot

Tested with template site and instructor dashboard:

openedx-webhooks · 2025-10-15T23:52:44Z

Thanks for the pull request, @diana-villalvazo-wgu!

This repository is currently maintained by @openedx/axim-engineering.

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.

shell/header/course-navigation-bar/CourseTabsNavigation.tsx

brian-smith-tcril · 2025-10-31T17:22:54Z

@arbrandes do you remember which FWG meeting we discussed this in? I think I need to look through our discussion to remember how the "render conditionally based on role" part is supposed to work (IIRC we talked about apps having roles associated?)

diana-villalvazo-wgu · 2025-10-31T17:34:13Z

@arbrandes do you remember which FWG meeting we discussed this in? I think I need to look through our discussion to remember how the "render conditionally based on role" part is supposed to work (IIRC we talked about apps having roles associated?)

we discussed it on this one https://openedx.atlassian.net/wiki/spaces/COMM/pages/5255593985/2025-10-09+Frontend+Working+Group+Meeting+Notes+Shai-Hulud+Program+Dashboard+etc

For now i didn't introduce anything related to roles and just abstract how is working now (retrieving the enabled tabs from the course-metadata endpoint)

mphilbrick211 · 2026-01-06T21:59:29Z

Friendly ping on this, @brian-smith-tcril @arbrandes

shell/header/course-navigation-bar/course-tabs-navigation.scss

arbrandes

Looks good! I do have some questions and comments, but I think this would work, architecturally speaking. I know we discussed having a way to dynamically assign roles, but we can cross that bridge when we get there.

(Also, sorry it took a while to get here.)

shell/header/course-navigation-bar/CourseTabsNavigation.tsx

shell/header/course-navigation-bar/data/service.ts

shell/header/course-navigation-bar/CourseTabsNavigation.tsx

arbrandes · 2026-01-27T19:55:38Z

shell/header/course-navigation-bar/CourseTabsNavigation.tsx

+          <div className="nav-menu">
+            <Tabs className="nav-underline-tabs" aria-label={intl.formatMessage(messages.courseMaterial)} onSelect={handleSelectedTab}>
+              {tabs.map(({ title, slug }) => (
+                <Tab eventKey={slug} title={title} key={slug} />


I think we might want to use activeKey too, here, no? To give the user indication of which one is active.

shell/header/course-navigation-bar/data/service.ts

arbrandes · 2026-01-27T20:19:37Z

I also just realized that openedx/frontend-app-instructor-dashboard#32 is not doing the same thing. It's solving a similar problem, though, so we should keep both implementations in sync where it makes sense.

arbrandes

A few more questions and suggestions, if you don't mind. Thanks!

shell/header/course-navigation-bar/CourseTabsNavigation.tsx

shell/header/course-navigation-bar/messages.ts

mphilbrick211 · 2026-04-06T19:24:21Z

Hi @diana-villalvazo-wgu! Is this PR still in progress?

diana-villalvazo-wgu · 2026-04-07T20:23:35Z

shell/header/course-navigation-bar/course-tabs-navigation.scss

@@ -0,0 +1,7 @@
+.course-tabs-navigation {
+  border-bottom: 2px solid var(--pgn-color-nav-tabs-base-border-base);


styles needed if we want to keep the underline for the whole page and not only for the extension on the tabs

* feat: add `provides` field to App for inter-app data sharing Add a generic mechanism for apps to share data with each other without requiring changes to the App type for each new use case. Includes ADR 0013 documenting the design rationale. Co-Authored-By: Claude <noreply@anthropic.com> * refactor: use `provides` for course navigation bar Replace hardcoded role list with dynamic `provides` lookup. The slot condition now uses a callback that checks registered apps' URL patterns. Tab links use `Link` for client routes and `<a href>` for external ones. Co-Authored-By: Claude <noreply@anthropic.com> * fix: type raw API response and remove dead isMasquerading Co-Authored-By: Claude <noreply@anthropic.com> * refactor: use find-based SCSS copy in Makefile Co-Authored-By: Claude <noreply@anthropic.com> * fix: resolve circular dependency between app.tsx and utils.ts Co-Authored-By: Claude <noreply@anthropic.com> * refactor: use roles instead of URL patterns in provides Apps now provide role names instead of regex patterns. The header derives route paths from roles via getUrlByRouteRole, avoiding duplication of URL knowledge. Co-Authored-By: Claude <noreply@anthropic.com> * refactor: use matchPath for tab and route matching, add tests Replace manual prefix matching with react-router's matchPath in both getActiveTabId and isClientRoute. Add component tests for CourseTabsNavigation and unit tests for utils. Co-Authored-By: Claude <noreply@anthropic.com> * refactor: allow any namespaced ID as provides key The provides key is not limited to app IDs - any namespaced identifier in the ecosystem (slot, widget, etc.) can be used. The course navigation bar now uses its widget ID. ADR updated to reflect this and document rejected alternatives. Co-Authored-By: Claude <noreply@anthropic.com> * refactor: use dedicated provides key, not existing IDs Provides keys should be their own namespaced identifiers so the data can be consumed by any entity independently. Co-Authored-By: Claude <noreply@anthropic.com> * fix: lint error in CourseTabsNavigation test Co-Authored-By: Claude <noreply@anthropic.com> * docs: fix ADR wording * fix: decouple getProvidedData from app ID references Rename parameter to 'key', update JSDoc, and align tests with the convention that provides keys are their own namespaced identifiers. Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>

arbrandes

Alright, nice collab!

openedx-semantic-release-bot · 2026-04-08T21:59:19Z

🎉 This PR is included in version 1.0.0-alpha.23 🎉

The release is available on:

Your semantic-release bot 📦🚀

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 Oct 15, 2025

openedx-webhooks added this to Contributions Oct 15, 2025

github-project-automation bot moved this to Needs Triage in Contributions Oct 15, 2025

diana-villalvazo-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Oct 15, 2025

diana-villalvazo-wgu commented Oct 15, 2025

View reviewed changes

shell/header/course-navigation-bar/CourseTabsNavigation.tsx Outdated Show resolved Hide resolved

diana-villalvazo-wgu force-pushed the courseNavigationBar branch 3 times, most recently from 114be5d to a79f6cf Compare October 16, 2025 18:33

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 16, 2025

diana-villalvazo-wgu force-pushed the courseNavigationBar branch from a79f6cf to 45c11fe Compare October 17, 2025 15:12

diana-villalvazo-wgu commented Oct 17, 2025

View reviewed changes

shell/header/course-navigation-bar/CourseTabsNavigation.tsx Outdated Show resolved Hide resolved

diana-villalvazo-wgu force-pushed the courseNavigationBar branch 2 times, most recently from e883f25 to 4536f10 Compare October 20, 2025 22:18

diana-villalvazo-wgu commented Oct 20, 2025

View reviewed changes

shell/header/course-navigation-bar/CourseTabsNavigation.tsx Outdated Show resolved Hide resolved

diana-villalvazo-wgu requested a review from arbrandes October 20, 2025 22:20

diana-villalvazo-wgu marked this pull request as ready for review October 20, 2025 22:20

diana-villalvazo-wgu moved this from Waiting on Author to Ready for Review in Contributions Oct 20, 2025

diana-villalvazo-wgu force-pushed the courseNavigationBar branch from 4536f10 to 26b19ea Compare October 30, 2025 15:31

diana-villalvazo-wgu requested a review from brian-smith-tcril October 30, 2025 15:39

mphilbrick211 moved this from Ready for Review to In Eng Review in Contributions Nov 6, 2025

mphilbrick211 moved this from In Eng Review to Ready for Review in Contributions Nov 13, 2025

arbrandes mentioned this pull request Jan 19, 2026

Create course navigation bar component #149

Open

jesusbalderramawgu reviewed Jan 27, 2026

View reviewed changes

shell/header/course-navigation-bar/course-tabs-navigation.scss Outdated Show resolved Hide resolved

arbrandes requested changes Jan 27, 2026

View reviewed changes

diana-villalvazo-wgu force-pushed the courseNavigationBar branch 2 times, most recently from df88abc to dbaed01 Compare February 17, 2026 15:35

arbrandes requested changes Feb 18, 2026

View reviewed changes

diana-villalvazo-wgu force-pushed the courseNavigationBar branch 3 times, most recently from 1638f0a to 3999521 Compare February 18, 2026 16:04

diana-villalvazo-wgu added 7 commits April 7, 2026 10:53

feat: introduce courseNavigationBar

598f50d

chore: add slot for extra content on learning

fd123fe

chore: addressing feedback

c24e7dc

fix: address feedback on try catch and design tokens

6ec2f97

refactor: use Nav for course tabs

68b3e47

fix: add aria label

8343ac2

fix: add types to tabs

843df1c

diana-villalvazo-wgu force-pushed the courseNavigationBar branch 2 times, most recently from 36d94e2 to d7623b9 Compare April 7, 2026 20:20

diana-villalvazo-wgu requested a review from holaontiveros April 7, 2026 20:21

fix: get active tab

de6fc4e

diana-villalvazo-wgu force-pushed the courseNavigationBar branch from d7623b9 to de6fc4e Compare April 7, 2026 20:23

diana-villalvazo-wgu commented Apr 7, 2026

View reviewed changes

diana-villalvazo-wgu requested a review from arbrandes April 7, 2026 22:30

diana-villalvazo-wgu force-pushed the courseNavigationBar branch from b4c9312 to 82c6761 Compare April 8, 2026 21:47

arbrandes approved these changes Apr 8, 2026

View reviewed changes

arbrandes merged commit 49427eb into openedx:main Apr 8, 2026
5 checks passed

github-project-automation bot moved this from In Eng Review to Done in Contributions Apr 8, 2026

openedx-semantic-release-bot added the released on @latest label Apr 8, 2026

diana-villalvazo-wgu deleted the courseNavigationBar branch April 8, 2026 21:59

diana-villalvazo-wgu mentioned this pull request Apr 8, 2026

Add course nav provides openedx/frontend-app-instructor-dashboard#148

Merged

6 tasks

		@@ -0,0 +1,7 @@
		.course-tabs-navigation {
		border-bottom: 2px solid var(--pgn-color-nav-tabs-base-border-base);

Conversation

diana-villalvazo-wgu commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshot

Uh oh!

openedx-webhooks commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brian-smith-tcril commented Oct 31, 2025

Uh oh!

diana-villalvazo-wgu commented Oct 31, 2025

Uh oh!

mphilbrick211 commented Jan 6, 2026

Uh oh!

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arbrandes Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arbrandes commented Jan 27, 2026

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mphilbrick211 commented Apr 6, 2026

Uh oh!

diana-villalvazo-wgu Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

openedx-semantic-release-bot commented Apr 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

diana-villalvazo-wgu commented Oct 15, 2025 •

edited

Loading

openedx-webhooks commented Oct 15, 2025 •

edited

Loading