Introduce courseNavigationBar on header slot #106

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

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.

diana-villalvazo-wgu · 2025-10-15T23:54:55Z

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

+      if (selectedUrl.startsWith('http://') || selectedUrl.startsWith('https://')) {
+        const url = new URL(selectedUrl);
+        if (url.origin === window.location.origin) {
+          navigate(url.pathname + url.search + url.hash);


tried to use navigate as much as possible so we can preserve app state and avoid unneeded full page load

I see, thanks for the explanation

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

diana-villalvazo-wgu · 2025-10-20T22:19:33Z

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

+              ))}
+            </Tabs>
+          </div>
+          <Slot id="org.openedx.frontend.slot.header.courseNavigationBar.extraContent.v1" />


This slot was added because on current learning MFE this nav bar has some extra content related to courseware search

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

jesusbalderramawgu · 2026-01-27T18:28:50Z

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

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


why do you remove the variable for a hardcoded color?

maybe you could create a variable something like
$border-base-tabs-color: rgb(232.5, 229.5, 228)
and use that

when i created this PR, design tokens on frontend base wasn't ready, so didn't work, i left the comment to remember that and update it when that was ready

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

arbrandes · 2026-01-27T19:40:47Z

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

+  const { data } = useQuery({
+    queryKey: ['org.openedx.frontend.app.header.course-meta', courseId],
+    queryFn: () => getCourseHomeCourseMetadata(courseId),
+    retry: 2,
+  });


Shouldn't we be handling isLoading and isError from useQuery, maybe with some UI indication that loading is happening?

do we do anything like that currently? if it's just for the data for the bar I would expect to show it or not when we get the info, it should be quick enough and prevent extra things to mantain (?)

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

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

arbrandes · 2026-01-27T19:48:45Z

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

+  };
+
+  return (
+    <div id="courseTabsNavigation" className={classNames('course-tabs-navigation')}>


Any particular reason we need classNames here?

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-instruct#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.

holaontiveros · 2026-01-27T21:12:16Z

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

@@ -0,0 +1,81 @@
+import { useQuery } from '@tanstack/react-query';
+import { Slot, useIntl } from '../../../runtime';


if possible make it absolute

holaontiveros · 2026-01-27T21:15:00Z

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

+  const { data } = useQuery({
+    queryKey: ['org.openedx.frontend.app.header.course-meta', courseId],
+    queryFn: () => getCourseHomeCourseMetadata(courseId),
+    retry: 2,
+  });


do we do anything like that currently? if it's just for the data for the bar I would expect to show it or not when we get the info, it should be quick enough and prevent extra things to mantain (?)

holaontiveros · 2026-01-27T21:16:29Z

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

+    const selectedUrl = tabs.find(tab => tab.slug === eventKey)?.url ?? '/';
+
+    try {
+      if (selectedUrl.startsWith('http://') || selectedUrl.startsWith('https://')) {


Just to understand in which case the selectedUrl woudln't have http or https?

a case could be a custom implementation that just points to a route on same domain for example if someone sent /cohorts and with navigate will go to that page 🤔 but not sure if im overcomplicating this

holaontiveros · 2026-01-27T21:17:41Z

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

+          window.location.href = selectedUrl;
+        }
+      } else {
+        navigate(selectedUrl);


if there's an issue with the URL you are trying to parse why are you navigating to it?

holaontiveros · 2026-01-27T21:18:29Z

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

+  const courseId = extractCourseId(location.pathname);
+
+  const { data } = useQuery({
+    queryKey: ['org.openedx.frontend.app.header.course-meta', courseId],


shouldn't this base ID be a constant?

holaontiveros · 2026-01-29T18:42:40Z

I also just realized that openedx/frontend-app-instruct#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.

I think it got out of sync because there was extra work that was done in instruct after the decision of just migrating this ones as they were

I would say that it makes sense if we wrap this one up with the current changes and as inmediate followup we do the update so this one is more in sync with instruct dash, what do you think @arbrandes ?

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

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

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

arbrandes requested changes Jan 27, 2026

View reviewed changes

holaontiveros reviewed Jan 27, 2026

View reviewed changes

diana-villalvazo-wgu added 3 commits January 29, 2026 08:50

feat: introduce courseNavigationBar

caa631a

chore: add slot for extra content on learning

eacf71f

chore: addressing feedback

5681171

diana-villalvazo-wgu force-pushed the courseNavigationBar branch from 26b19ea to 5681171 Compare January 29, 2026 18:40

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

		@@ -0,0 +1,81 @@
		import { useQuery } from '@tanstack/react-query';
		import { Slot, useIntl } from '../../../runtime';

Introduce courseNavigationBar on header slot #106

Are you sure you want to change the base?

Introduce courseNavigationBar on header slot #106

Uh oh!

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!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

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!

Choose a reason for hiding this comment

Uh oh!

diana-villalvazo-wgu Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arbrandes commented Jan 27, 2026

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!

holaontiveros commented Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

diana-villalvazo-wgu commented Oct 15, 2025 •

edited

Loading

openedx-webhooks commented Oct 15, 2025 •

edited

Loading

diana-villalvazo-wgu Oct 15, 2025 •

edited

Loading

diana-villalvazo-wgu Jan 27, 2026 •

edited

Loading