Skip to content

fix: course sidebar slot#3056

Merged
saraburns1 merged 1 commit into
openedx:masterfrom
open-craft:rpenido/fix-course-sidebar
May 11, 2026
Merged

fix: course sidebar slot#3056
saraburns1 merged 1 commit into
openedx:masterfrom
open-craft:rpenido/fix-course-sidebar

Conversation

@rpenido
Copy link
Copy Markdown
Contributor

@rpenido rpenido commented May 11, 2026

Description

This PR fixes the rendering of the slot org.openedx.frontend.authoring.course_outline_sidebar.v1 while using Insert operation.

image

Supporting information

Testing instructions

  • Use the following env.config.jsx
import { PLUGIN_OPERATIONS, DIRECT_PLUGIN } from '@openedx/frontend-plugin-framework';

import { Card } from "@openedx/paragon"

const config = {
  pluginSlots: {
    'org.openedx.frontend.authoring.course_outline_sidebar.v1': {
      keepDefault: true,
      plugins: [
        {
          op: PLUGIN_OPERATIONS.Insert,
          widget: {
              id: 'course-sidebar',
              priority: 1,
              type: DIRECT_PLUGIN,
              RenderWidget: () => <Card><Card.Header title="v1"/></Card>,
          },
        },
        {
            op: PLUGIN_OPERATIONS.Wrap,
            widgetId: 'default_contents',
            wrapper: ({component}) => <div style={{ border: 'thick dashed green' }}>{component}</div>,
        },
      ],
    },
  },
};

export default config;
  • Check that the v1 card is rendered before the sidebar, and you have a green dashed line around the sidebar.

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 11, 2026
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @rpenido!

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
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.52%. Comparing base (0188698) to head (809740c).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3056   +/-   ##
=======================================
  Coverage   95.52%   95.52%           
=======================================
  Files        1393     1393           
  Lines       32969    32969           
  Branches     7592     7599    +7     
=======================================
  Hits        31493    31493           
- Misses       1408     1421   +13     
+ Partials       68       55   -13     

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

@saraburns1 saraburns1 merged commit 4145689 into openedx:master May 11, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions May 11, 2026
@rpenido rpenido deleted the rpenido/fix-course-sidebar branch May 12, 2026 01:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants