Skip to content

feat: add Proctoring Info Panel plugin slot #1759

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.

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
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Anas12091101
Copy link

@Anas12091101 Anas12091101 commented Jul 9, 2025

Description

This PR introduces a plugin slot to enable overriding the ProctoringInfoPanel component. It also adds a new proctoringReviewRequirementsButtonLink prop in the ProctoringInfoPanel, allowing customization of the "Review instructions and system requirements" link without requiring a full replacement of the ProctoringInfoPanel.

Screenshots

  • Default
    Screenshot 2025-07-09 at 12 24 40 PM

  • Custom
    Screenshot 2025-07-09 at 12 00 13 PM

Testing Instructions

  • Override the plugin slot by pasting the following config in the env.config.jsx file
    import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';
    
    const config = {
     pluginSlots: {
       "org.openedx.frontend.learning.proctoring_info_panel.v1":{
           plugins: [
             {
               op: PLUGIN_OPERATIONS.Insert,
               widget: {
                 id: 'proctoring_info_panel',
                 type: DIRECT_PLUGIN,
                 RenderWidget: () => <h3>Proctoring Info Panel</h3>,
               },
             },
           ],
       }}
    }
    export default config;
  • Ensure that the custom component is rendered in place of the default component.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 9, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

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.


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.

* `proctoring_info_panel_slot`

### Props:
* `proctoringReviewRequirementsButtonLink`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great start, thanks! But it would be ideal if you could add:

  1. An example of how to use this slot, including sample env.config.jsx code.
  2. A screenshot of the slot using the above example.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @arbrandes!

The reason I initially left out the screenshots and env.config.jsx example was because I noticed that some of the recently added plugin slots, like ContentIFrameLoaderSlot were missing them in their README as well.

That said, I’ve now added the example screenshots and config code in 36e6ceb

@Anas12091101 Anas12091101 requested a review from arbrandes July 18, 2025 10:52
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: Needs Triage
Development

Successfully merging this pull request may close these issues.

3 participants