-
Notifications
You must be signed in to change notification settings - Fork 275
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
Closed
Anas12091101
wants to merge
2
commits into
openedx:master
from
mitodl:anas/proctoring-info-plugin-slot
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Procotoring Info Panel Slot | ||
|
||
### Slot ID: `org.openedx.frontend.learning.proctoring_info_panel.v1` | ||
|
||
### Slot ID Aliases | ||
* `proctoring_info_panel_slot` | ||
|
||
### Props: | ||
* `proctoringReviewRequirementsButtonLink` | ||
|
||
## Description | ||
|
||
This slot is used to replace/modify/hide the proctoring info panel. | ||
|
||
## Example | ||
|
||
### Default content | ||
 | ||
|
||
### Replaced with custom component | ||
 | ||
|
||
The following `env.config.jsx` will replace the notifications discussions sidebar. | ||
|
||
```js | ||
import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework'; | ||
|
||
const config = { | ||
pluginSlots: { | ||
'org.openedx.frontend.learning.proctoring_info_panel.v1': { | ||
keepDefault: false, | ||
plugins: [ | ||
{ | ||
op: PLUGIN_OPERATIONS.Insert, | ||
widget: { | ||
id: 'proctoring_info_panel', | ||
type: DIRECT_PLUGIN, | ||
RenderWidget: () => <h3>Proctoring Info Panel</h3>, | ||
}, | ||
}, | ||
], | ||
} | ||
}, | ||
} | ||
|
||
export default config; | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
import React from 'react'; | ||
|
||
import { PluginSlot } from '@openedx/frontend-plugin-framework'; | ||
import ProctoringInfoPanel from '../../course-home/outline-tab/widgets/ProctoringInfoPanel'; | ||
|
||
export const ProctoringInfoPanelSlot = ( | ||
{ proctoringReviewRequirementsButtonLink }:ProctoringInfoPanelSlotProps, | ||
) => ( | ||
<PluginSlot | ||
id="org.openedx.frontend.learning.proctoring_info_panel.v1" | ||
idAliases={['proctoring_info_panel_slot']} | ||
slotOptions={{ | ||
mergeProps: true, | ||
}} | ||
> | ||
<ProctoringInfoPanel | ||
proctoringReviewRequirementsButtonLink={proctoringReviewRequirementsButtonLink ?? ''} | ||
/> | ||
</PluginSlot> | ||
); | ||
|
||
interface ProctoringInfoPanelSlotProps { | ||
proctoringReviewRequirementsButtonLink?: string; | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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:
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any slot that is missing documentation is a bug. All slots should have documentation. However some don't and if you have context on the ones that don't we'd love PRs. Some of the ones that don't have docs are because we found them, but we don't know how to use them.