Skip to content

fix: update sidebar design #2852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rpenido wants to merge 5 commits into
base: master
Choose a base branch
from
Open

fix: update sidebar design #2852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
86a3d03
fix: update sidebar design
rpenido Jan 30, 2026
fddabe6
fix: sidebar page order
rpenido Feb 3, 2026
4393dfc
Merge branch 'master' into rpenido/fal-4297/update-help-sidebar-design
rpenido Feb 3, 2026
10b24e8
fix: sidebar order
rpenido Feb 4, 2026
511a796
test: fix flaky test
rpenido Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/CourseAuthoringRoutes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import VideoSelectorContainer from './selectors/VideoSelectorContainer';
import CustomPages from './custom-pages';
import { FilesPage, VideosPage } from './files-and-videos';
import { AdvancedSettings } from './advanced-settings';
import { CourseOutline } from './course-outline';
import { CourseOutline, OutlineSidebarPagesProvider } from './course-outline';
import ScheduleAndDetails from './schedule-and-details';
import { GradingSettings } from './grading-settings';
import CourseTeam from './course-team/CourseTeam';
Expand Down Expand Up @@ -58,7 +58,13 @@ const CourseAuthoringRoutes = () => {
<Routes>
<Route
path="/"
element={<PageWrap><CourseOutline /></PageWrap>}
element={(
<PageWrap>
<OutlineSidebarPagesProvider>
<CourseOutline />
</OutlineSidebarPagesProvider>
</PageWrap>
)}
/>
<Route
path="course_info"
Expand Down
5 changes: 4 additions & 1 deletion src/course-outline/CourseOutline.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ import {
} from './__mocks__';
import { COURSE_BLOCK_NAMES, VIDEO_SHARING_OPTIONS } from './constants';
import CourseOutline from './CourseOutline';
import { OutlineSidebarPagesProvider } from './outline-sidebar/OutlineSidebarPagesContext';

import messages from './messages';
import headerMessages from './header-navigations/messages';
Expand Down Expand Up @@ -139,7 +140,9 @@ const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

const renderComponent = () => render(
<CourseAuthoringProvider courseId={courseId}>
<CourseOutline />
<OutlineSidebarPagesProvider>
<CourseOutline />
</OutlineSidebarPagesProvider>
</CourseAuthoringProvider>,
);

Expand Down
1 change: 1 addition & 0 deletions src/course-outline/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export { default as CourseOutline } from './CourseOutline';
export { OutlineSidebarPagesProvider } from './outline-sidebar/OutlineSidebarPagesContext';
41 changes: 21 additions & 20 deletions src/course-outline/outline-sidebar/OutlineHelpSidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import { Hyperlink } from '@openedx/paragon';
import { useIntl } from '@edx/frontend-platform/i18n';
import { SchoolOutline } from '@openedx/paragon/icons';

import { HelpSidebar } from '@src/generic/help-sidebar';
import { SidebarContent, SidebarSection, SidebarTitle } from '@src/generic/sidebar';
import { useHelpUrls } from '@src/help-urls/hooks';
import { useCourseAuthoringContext } from '@src/CourseAuthoringContext';

import { useCourseDetails } from '../data/apiHooks';
import { getFormattedSidebarMessages } from './utils';

const OutlineHelpSideBar = () => {
Expand All @@ -15,6 +17,7 @@ const OutlineHelpSideBar = () => {
outline: learnMoreOutlineUrl,
} = useHelpUrls(['visibility', 'grading', 'outline']);
const { courseId } = useCourseAuthoringContext();
const { data: courseDetails } = useCourseDetails(courseId);

const sidebarMessages = getFormattedSidebarMessages(
{
Expand All @@ -26,36 +29,34 @@ const OutlineHelpSideBar = () => {
);

return (
<HelpSidebar
courseId={courseId}
showOtherSettings={false}
className="outline-sidebar mt-4"
data-testid="outline-sidebar"
>
{sidebarMessages.map(({ title, descriptions, link }, index) => {
const isLastSection = index === sidebarMessages.length - 1;

return (
<div className="outline-sidebar-section" key={title}>
<h4 className="help-sidebar-about-title">{title}</h4>
<>
<SidebarTitle
title={courseDetails?.title || ''}
icon={SchoolOutline}
/>
<SidebarContent>
{sidebarMessages.map(({ title, descriptions, link }) => (
<SidebarSection
key={title}
title={title}
>
{descriptions.map((description) => (
<p className="help-sidebar-about-descriptions" key={description}>{description}</p>
<p className="x-small" key={description}>{description}</p>
))}
{!!link?.href && (
<Hyperlink
className="small"
className="x-small"
destination={link.href}
target="_blank"
showLaunchIcon={false}
>
{link.text}
</Hyperlink>
)}
{!isLastSection && <hr className="my-3.5" />}
</div>
);
})}
</HelpSidebar>
</SidebarSection>
))}
</SidebarContent>
</>
);
};

Expand Down
9 changes: 6 additions & 3 deletions src/course-outline/outline-sidebar/OutlineSidebar.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
import { CourseAuthoringProvider } from '@src/CourseAuthoringContext';

import { OutlineSidebarProvider } from './OutlineSidebarContext';
import { OutlineSidebarPagesProvider } from './OutlineSidebarPagesContext';
import OutlineSidebar from './OutlineSidebar';

// Mock the useCourseDetails hook
Expand All @@ -19,9 +20,11 @@ const courseId = '123';

const extraWrapper = ({ children }) => (
<CourseAuthoringProvider courseId={courseId}>
<OutlineSidebarProvider>
{children}
</OutlineSidebarProvider>
<OutlineSidebarPagesProvider>
<OutlineSidebarProvider>
{children}
</OutlineSidebarProvider>
</OutlineSidebarPagesProvider>
</CourseAuthoringProvider>
);

Expand Down
42 changes: 29 additions & 13 deletions src/course-outline/outline-sidebar/OutlineSidebarPagesContext.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { createContext, useContext } from 'react';
import { createContext, useContext, useMemo } from 'react';
import { getConfig } from '@edx/frontend-platform';
import {
HelpOutline, Info, Plus, Tag,
Expand All @@ -19,15 +19,18 @@ export type OutlineSidebarPages = {
align?: SidebarPage;
};

const showAlignSidebar = getConfig().ENABLE_TAGGING_TAXONOMY_PAGES === 'true';

const OUTLINE_SIDEBAR_PAGES: OutlineSidebarPages = {
const getOutlineSidebarPages = () => ({
info: {
component: OutlineInfoSidebar,
icon: Info,
title: messages.sidebarButtonInfo,
},
...(showAlignSidebar && {
add: {
component: AddSidebar,
icon: Plus,
title: messages.sidebarButtonAdd,
},
...(getConfig().ENABLE_TAGGING_TAXONOMY_PAGES === 'true' && {
align: {
component: OutlineAlignSidebar,
icon: Tag,
Expand All @@ -39,12 +42,7 @@ const OUTLINE_SIDEBAR_PAGES: OutlineSidebarPages = {
icon: HelpOutline,
title: messages.sidebarButtonHelp,
},
add: {
component: AddSidebar,
icon: Plus,
title: messages.sidebarButtonAdd,
},
};
});

/**
* Context for the Outline Sidebar Pages.
Expand Down Expand Up @@ -77,6 +75,24 @@ const OUTLINE_SIDEBAR_PAGES: OutlineSidebarPages = {
* );
*}
*/
export const OutlineSidebarPagesContext = createContext<OutlineSidebarPages>(OUTLINE_SIDEBAR_PAGES);
export const OutlineSidebarPagesContext = createContext<OutlineSidebarPages | undefined>(undefined);

type OutlineSidebarPagesProviderProps = {
children: React.ReactNode;
};

export const useOutlineSidebarPagesContext = (): OutlineSidebarPages => useContext(OutlineSidebarPagesContext);
export const OutlineSidebarPagesProvider = ({ children }: OutlineSidebarPagesProviderProps) => {
const sidebarPages = useMemo(getOutlineSidebarPages, []);

return (
<OutlineSidebarPagesContext.Provider value={sidebarPages}>
{children}
</OutlineSidebarPagesContext.Provider>
);
};

export const useOutlineSidebarPagesContext = (): OutlineSidebarPages => {
const ctx = useContext(OutlineSidebarPagesContext);
if (ctx === undefined) { throw new Error('useOutlineSidebarPages must be used within an OutlineSidebarPagesProvider'); }
return ctx;
};
45 changes: 0 additions & 45 deletions src/course-outline/outline-sidebar/sidebarPages.ts
View file
Open in desktop

This file was deleted.

24 changes: 11 additions & 13 deletions src/course-unit/CourseUnit.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,17 +581,16 @@ describe('<CourseUnit />', () => {
published_preview_link: publishedPreviewLink,
} = courseSectionVerticalMock;

await waitFor(async () => {
const viewLiveButton = screen.getByRole('button', { name: headerNavigationsMessages.viewLiveButton.defaultMessage });
await user.click(viewLiveButton);
expect(window.open).toHaveBeenCalled();
expect(window.open).toHaveBeenCalledWith(publishedPreviewLink, '_blank');
const viewLiveButton = await screen.findByRole('button', { name: headerNavigationsMessages.viewLiveButton.defaultMessage });

const previewButton = screen.getByRole('button', { name: headerNavigationsMessages.previewButton.defaultMessage });
await user.click(previewButton);
expect(window.open).toHaveBeenCalled();
expect(window.open).toHaveBeenCalledWith(draftPreviewLink, '_blank');
});
await user.click(viewLiveButton);
expect(window.open).toHaveBeenCalled();
expect(window.open).toHaveBeenCalledWith(publishedPreviewLink, '_blank');

const previewButton = screen.getByRole('button', { name: headerNavigationsMessages.previewButton.defaultMessage });
await user.click(previewButton);
expect(window.open).toHaveBeenCalled();
expect(window.open).toHaveBeenCalledWith(draftPreviewLink, '_blank');

window.open = open;
});
Expand Down Expand Up @@ -870,9 +869,8 @@ describe('<CourseUnit />', () => {
.reply(200, courseCreateXblockMock);
render(<RootWrapper />);

await waitFor(async () => {
await user.click(screen.getByRole('button', { name: legacySidebarMessages.actionButtonPublishTitle.defaultMessage }));
});
const publishButton = await screen.findByRole('button', { name: legacySidebarMessages.actionButtonPublishTitle.defaultMessage });
await user.click(publishButton);

axiosMock
.onPost(getXBlockBaseApiUrl(blockId), {
Expand Down