feat: introduce courseNavigationBar

Author: diana-villalvazo-wgu

shell/header/Header.tsx

@@ -6,12 +6,15 @@ export default function Header() {
   const intl = useIntl();
 
   return (
-    <header className="border-bottom py-2">
-      <nav className="py-2">
-        <a className="sr-only sr-only-focusable" href="#main-content">{intl.formatMessage(messages.skipNavLink)}</a>
-        <Slot id="org.openedx.frontend.slot.header.desktop.v1" />
-        <Slot id="org.openedx.frontend.slot.header.mobile.v1" />
-      </nav>
-    </header>
+    <>
+      <header className="border-bottom py-2">
+        <nav className="py-2">
+          <a className="sr-only sr-only-focusable" href="#main-content">{intl.formatMessage(messages.skipNavLink)}</a>
+          <Slot id="org.openedx.frontend.slot.header.desktop.v1" />
+          <Slot id="org.openedx.frontend.slot.header.mobile.v1" />
+        </nav>
+      </header>
+      <Slot id="org.openedx.frontend.slot.header.courseNavigationBar.v1" />
+    </>
   );
 }

shell/header/app.tsx

@@ -12,6 +12,7 @@ import MobileLayout from './mobile/MobileLayout';
 import MobileNavLinks from './mobile/MobileNavLinks';
 
 import messages from '../Shell.messages';
+import CourseTabsNavigation from './course-navigation-bar/CourseTabsNavigation';
 
 const config: App = {
   appId: 'org.openedx.frontend.app.header',
@@ -136,6 +137,12 @@ const config: App = {
         authenticated: false,
       }
     },
+    {
+      slotId: 'org.openedx.frontend.slot.header.courseNavigationBar.v1',
+      id: 'org.openedx.frontend.widget.header.courseTabsNavigation.v1',
+      op: WidgetOperationTypes.APPEND,
+      component: CourseTabsNavigation,
+    }
   ]
 };
 

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

@@ -0,0 +1,83 @@
+import { useQuery } from '@tanstack/react-query';
+import { useIntl } from '../../../runtime';
+import classNames from 'classnames';
+import { getCourseHomeCourseMetadata } from './data/service';
+import { Tab, Tabs } from '@openedx/paragon';
+import messages from './messages';
+import { useNavigate, useLocation } from 'react-router-dom';
+import './course-tabs-navigation.scss';
+
+interface CourseMetaData {
+  tabs: {
+    title: string,
+    slug: string,
+    url: string,
+  }[],
+  isMasquerading: boolean,
+}
+
+const CourseTabsNavigation = () => {
+  const location = useLocation();
+
+  const extractCourseId = (pathname: string): string => {
+    const courseRegex = /\/courses?\/([^/]+)/;
+    const courseMatch = courseRegex.exec(pathname);
+    return courseMatch ? courseMatch[1] : '';
+  };
+
+  const courseId = extractCourseId(location.pathname);
+
+  const { data } = useQuery({
+    queryKey: ['org.openedx.frontend.app.header.course-meta', courseId],
+    queryFn: () => getCourseHomeCourseMetadata(courseId),
+    retry: 2,
+  });
+
+  const { tabs = [] }: CourseMetaData = data ?? {};
+
+  const intl = useIntl();
+  const navigate = useNavigate();
+
+  const handleSelectedTab = (eventKey) => {
+    const selectedUrl = tabs.find(tab => tab.slug === eventKey)?.url ?? '/';
+
+    try {
+      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);
+        } else {
+          window.location.href = selectedUrl;
+        }
+      } else {
+        navigate(selectedUrl);
+      }
+    } catch (error) {
+      navigate(selectedUrl);
+    }
+  };
+
+  return (
+    <div id="courseTabsNavigation" className={classNames('course-tabs-navigation')}>
+      <div className="container-xl">
+        <div className="nav-bar">
+          <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} />
+              ))}
+            </Tabs>
+          </div>
+          {/* <div className="search-toggle">
+            <CoursewareSearchToggle />
+          </div>
+        </div>
+      </div>
+      {show && <CoursewareSearch />} */}
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default CourseTabsNavigation;

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

@@ -0,0 +1,15 @@
+.course-tabs-navigation {
+  position: relative;
+  border-bottom: 2px solid rgb(232.5, 229.5, 228); // var(--pgn-color-nav-tabs-base-border-base)
+
+  .search-toggle {
+    flex-grow: 0;
+    text-align: right;
+    white-space: nowrap;
+    margin-bottom: 10px;
+  }
+
+  .nav-tabs {
+    border-bottom: none;
+  }
+}

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

@@ -0,0 +1,23 @@
+import { getSiteConfig, getAuthenticatedHttpClient, camelCaseObject } from '../../../../runtime';
+
+export const getCourseMetadataApiUrl = (courseId) => `${getSiteConfig().lmsBaseUrl}/api/course_home/course_metadata/${courseId}`;
+
+function normalizeCourseHomeCourseMetadata(metadata) {
+  const data = camelCaseObject(metadata);
+  return {
+    ...data,
+    tabs: data.tabs.map(tab => ({
+      slug: tab.tabId === 'courseware' ? 'outline' : tab.tabId,
+      title: tab.title,
+      url: tab.url,
+    })),
+    isMasquerading: data.originalUserIsStaff && !data.isStaff,
+  };
+}
+
+export async function getCourseHomeCourseMetadata(courseId) {
+  const url = getCourseMetadataApiUrl(courseId);
+  const { data } = await getAuthenticatedHttpClient().get(url);
+
+  return normalizeCourseHomeCourseMetadata(data);
+}

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

@@ -0,0 +1,11 @@
+import { defineMessages } from '../../../runtime';
+
+const messages = defineMessages({
+  courseMaterial: {
+    id: 'org.openedx.frontend.slot.header.courseNavigationBar.tabs.label',
+    defaultMessage: 'Course Material',
+    description: 'The accessible label for course tabs navigation',
+  },
+});
+
+export default messages;