feat: settings tab in sidebar by navinkarkera · Pull Request #2968 · openedx/frontend-app-authoring

navinkarkera · 2026-03-30T16:12:40Z

Description

Adds settings tab to section, subsection and unit sidebar in outline and unit page as described in #2794

Also, simplifies notification and unit settings in unit page using react-query, removing redux.

Useful information to include:

Which user roles will this change impact? "Course Author"

Screenshots:

Supporting information

Related to Section/Subsection/Unit Settings #2794
Private-ref: https://tasks.opencraft.com/browse/FAL-4324

Testing instructions

Create section, subsection and unit in a course.
Select them and check settings tab in sidebar for each element.
Try out different options in the settings sidebar and compare it with configure modal (three dots menu -> configure).

Other information

Leave without saving? This functionality is only working when user tries to leave the page. But changing the tab or closing the sidebar does not trigger this confirmation modal, it will require extensive changes and is not feasible with current limited time and budget.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

Any new files are using TypeScript (.ts, .tsx).
Avoid propTypes and defaultProps in any new or modified code.
Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
All new i18n messages in messages.ts files have a description for translators to use.
Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

openedx-webhooks · 2026-03-30T16:12:47Z

Thanks for the pull request, @navinkarkera!

This repository is currently maintained by @bradenmacdonald.

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-04-03T11:55:21Z

Codecov Report

❌ Patch coverage is 97.56098% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.59%. Comparing base (2930265) to head (dbb2458).

Files with missing lines	Patch %	Lines
src/generic/expandable-card/ExpandableCard.tsx	85.71%	5 Missing ⚠️
...unit-sidebar/unit-info/GenericUnitInfoSettings.tsx	94.11%	3 Missing ⚠️
...e/outline-sidebar/info-sidebar/UnitInfoSidebar.tsx	87.50%	2 Missing ⚠️
.../info-sidebar/sharedSettings/VisibilitySection.tsx	96.15%	1 Missing ⚠️
src/course-unit/legacy-sidebar/index.tsx	50.00%	1 Missing ⚠️
src/course-unit/xblock-container-iframe/index.tsx	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2968      +/-   ##
==========================================
+ Coverage   95.57%   95.59%   +0.02%     
==========================================
  Files        1366     1375       +9     
  Lines       31507    31877     +370     
  Branches     7119     7259     +140     
==========================================
+ Hits        30113    30474     +361     
+ Misses       1344     1341       -3     
- Partials       50       62      +12

☔ View full report in Codecov by Sentry.
📢 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.

…or new design toggle stability

rpenido

LGTM 👍
Thank you for your work, @navinkarkera!

I tested this using the instructions from the PR
I read through the code
I checked for accessibility issues
Includes documentation

NOTE: Not in the scope of this task, but it seems weird to me that "2:00" is not a valid value for Time Alloted. I think it was a bug typing it and not getting it saved.

rpenido · 2026-04-09T19:54:29Z

src/course-outline/outline-sidebar/info-sidebar/SubsectionSettings.tsx

+    mutate({
+      itemId: subsectionId,
+      sectionId: selectedContainerState?.sectionId,
+      isVisibleToStaffOnly: itemData.visibilityState === VisibilityTypes.STAFF_ONLY,
+      releaseDate: itemData.start,
+      graderType: itemData.format == null ? 'notgraded' : itemData.format,
+      dueDate: itemData.due == null ? '' : itemData.due,
+      isTimeLimited: itemData.isTimeLimited,
+      isProctoredExam: itemData.isProctoredExam,
+      isOnboardingExam: itemData.isOnboardingExam,
+      isPracticeExam: itemData.isPracticeExam,
+      examReviewRules: itemData.examReviewRules,
+      defaultTimeLimitMinutes: itemData.defaultTimeLimitMinutes,
+      hideAfterDue: itemData.hideAfterDue === undefined ? false : itemData.hideAfterDue,
+      showCorrectness: itemData.showCorrectness,
+      isPrereq: itemData.isPrereq,
+      prereqUsageKey: itemData.prereq,
+      prereqMinScore: defaultPrereqScore(itemData.prereqMinScore),
+      prereqMinCompletion: defaultPrereqScore(itemData.prereqMinCompletion),
+      ...variables,
+    });
+  };


Don't we allow partial updates in our API, right?
With the current approach, we override the entire config using cached data on every change, which may cause concurrency issues.
If our API is not prepared for partial updates, the change may be big for this task, so I think we should live with it.

Yes, from what I've seen, it's always been handled that way

rpenido · 2026-04-09T20:04:16Z

src/generic/expandable-card/ExpandableCard.tsx

+
+  useEffect(() => {
+    const element = contentRef.current;
+    if (!element) { return () => {}; }


I think we can just return undefined here instead of an empty function

Suggested change

if (!element) { return () => {}; }

if (!element) { return; }

rpenido · 2026-04-09T20:38:48Z

src/course-outline/data/apiHooks.ts

  const { setData } = useScrollState(courseKey);
  const dispatch = useDispatch();
-  return useMutation({
+  return useMutationWithProcessingNotification({


Nice clean-up! 👍

rpenido · 2026-04-09T20:39:52Z

src/course-outline/data/apiHooks.ts

-    closeToast,
-  } = useToastContext();
+  const { showToast, closeToast } = useToastContext();
  return useMutation({


Can we use the useMutationWithProcessingNotification here? If not, could you please put a comment about it?

ChrisChV · 2026-04-11T00:15:43Z

src/generic/processing-notification/data/apiHooks.ts

+ * Wraps useMutation to add a processing notification when the mutation is initiated and removes it
+ * when the mutation is settled.
+ */
+export const useMutationWithProcessingNotification = <


Nice! 👍 👍

ChrisChV · 2026-04-11T00:26:24Z

@navinkarkera This checkbox cannot be unchecked by clicking on it, is that expected?

ChrisChV · 2026-04-11T00:39:15Z

src/generic/expandable-card/ExpandableCard.tsx

+  useEffect(() => {
+    if (contentRef.current) {
+      const { scrollHeight } = contentRef.current;
+      setNeedsExpansion(scrollHeight > maxHeight);
+    }
+  }, [children, maxHeight]);


@navinkarkera, I think this is duplicated. The above useEffect already does this

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 Mar 30, 2026

openedx-webhooks added this to Contributions Mar 30, 2026

github-project-automation bot moved this to Needs Triage in Contributions Mar 30, 2026

navinkarkera force-pushed the navin/fal-4324/settings-tab branch from 339bc8a to 04e3ada Compare March 30, 2026 16:13

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 1, 2026

navinkarkera force-pushed the navin/fal-4324/settings-tab branch 3 times, most recently from 87cef28 to 282bdad Compare April 3, 2026 11:44

navinkarkera requested a review from rpenido April 3, 2026 15:13

navinkarkera marked this pull request as ready for review April 3, 2026 15:13

navinkarkera force-pushed the navin/fal-4324/settings-tab branch from 06da56f to 9fbec58 Compare April 6, 2026 10:32

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Apr 6, 2026

mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Apr 6, 2026

navinkarkera added 14 commits April 9, 2026 15:46

feat: unit settings tab in outline

6b75429

fix: lint issues

c73592f

fix: settings tab lost on resize

de603d0

refactor: create global context to show processing notification

6589d41

refactor: create wrapper to show and hide notification

282f413

refactor: use single mutation for unit settings

eb1d263

refactor: simplify and merge duplicate unit configure options

9f8cf07

feat: subsection settings

2f35b4f

fixup! feat: subsection settings

dc80c6b

fixup! feat: subsection settings

7437997

refactor: improve response of unit settings

a451570

feat: section settings

e4d319b

refactor: convert highlights modal component to typescript

f98c070

feat: highlights card in section sidebar

cb84690

navinkarkera added 23 commits April 9, 2026 15:46

fix: lint isssues

b1a76cd

fix: lint issues

80fed93

fixup! fix: lint issues

0fc2392

test: fix typing

7270d10

fix: oxlint warnings

d459c08

test: section settings

66db837

test: subsection settings

f457cf7

fix: lint issues

ee779ee

fix: unrelated lint issues

9b79bf9

test: fix

b20509e

test: adjust UnitInfoSidebar to include PublishControls in Info tab f…

5f9442b

…or new design toggle stability

test: fix some failing tests

6fe15b5

test: fix all tests

06038c1

fix: lint issues

f6e9d97

feat: show confirmation modal if changing from staff to student visible

6e4a438

test: advancetab

f9461a9

fix: failing test

a28b7ea

fix: lint issues

df741fd

test: improve coverage

4a86b2f

test: unit info sidebar

cab1c5c

refactor: rebase

03993ab

fix: lint issues

d82b781

fix: rebase

dbb2458

navinkarkera force-pushed the navin/fal-4324/settings-tab branch from 9fbec58 to dbb2458 Compare April 9, 2026 10:17

rpenido reviewed Apr 9, 2026

View reviewed changes

navinkarkera added 2 commits April 10, 2026 22:11

fix: prerequisite setting in sidebar and partial updates

cada6a7

refactor: configure api and fix lint issues

df98f8a

ChrisChV reviewed Apr 11, 2026

View reviewed changes

ChrisChV requested changes Apr 11, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: settings tab in sidebar#2968

feat: settings tab in sidebar#2968
navinkarkera wants to merge 40 commits intoopenedx:masterfrom
open-craft:navin/fal-4324/settings-tab

navinkarkera commented Mar 30, 2026 •

edited

Loading

Uh oh!

openedx-webhooks commented Mar 30, 2026 •

edited

Loading

Uh oh!

codecov bot commented Apr 3, 2026 •

edited

Loading

Uh oh!

rpenido left a comment

Uh oh!

rpenido Apr 9, 2026

Uh oh!

ChrisChV Apr 10, 2026

Uh oh!

rpenido Apr 9, 2026

Uh oh!

rpenido Apr 9, 2026

Uh oh!

rpenido Apr 9, 2026

Uh oh!

ChrisChV Apr 11, 2026

Uh oh!

ChrisChV commented Apr 11, 2026

Uh oh!

ChrisChV Apr 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

navinkarkera commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Other information

Best Practices Checklist

Uh oh!

openedx-webhooks commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rpenido left a comment

Choose a reason for hiding this comment

Uh oh!

rpenido Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisChV Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

rpenido Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

rpenido Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

rpenido Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisChV Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

ChrisChV commented Apr 11, 2026

Uh oh!

ChrisChV Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

navinkarkera commented Mar 30, 2026 •

edited

Loading

openedx-webhooks commented Mar 30, 2026 •

edited

Loading

codecov bot commented Apr 3, 2026 •

edited

Loading