-
Notifications
You must be signed in to change notification settings - Fork 174
feat: Adds notification tray slot #638
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
farhaanbukhsh
wants to merge
5
commits into
openedx:master
from
open-craft:farhaan/adding-more-slots
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
87faedc
feat: Adds notification tray slot
farhaanbukhsh 9a2964f
fixup! feat: Adds notification tray slot
farhaanbukhsh 8fabcd1
fixup! feat: Adds notification tray slot
farhaanbukhsh 7e2ae6f
fixup! feat: Adds notification tray slot
farhaanbukhsh 505fa43
fixup! feat: Adds notification tray slot
farhaanbukhsh 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
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,81 @@ | ||
| # Notification Tray Slot | ||
|
|
||
| ### Slot ID: `org.openedx.frontend.layout.notification_tray.v1` | ||
|
|
||
| ## Description | ||
|
|
||
| This slot is used to replace, modify, or hide the contents of the notification tray in the Open edX header. It allows developers to easily extend or customize the notification tray using the [Open edX Frontend Plugin Framework](https://github.com/openedx/frontend-plugin-framework). | ||
|
|
||
| The slot is kept empty so that it can only be enabled when it is required else | ||
| nothing is displayed. | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Insert Notification Tray with Custom Component | ||
|
|
||
| The following `env.config.jsx` will replace the notification tray's contents entirely (in this case with a custom emoji icon): | ||
|
|
||
| ```jsx | ||
| import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework'; | ||
|
|
||
| const config = { | ||
| pluginSlots: { | ||
| 'org.openedx.frontend.layout.notification_tray.v1': { | ||
| keepDefault: false, | ||
| plugins: [ | ||
| { | ||
| op: PLUGIN_OPERATIONS.Insert, | ||
| widget: { | ||
| id: 'custom_notification_tray', | ||
| type: DIRECT_PLUGIN, | ||
| RenderWidget: () => ( | ||
| <span>🔔 Custom Notification</span> | ||
| ), | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| export default config; | ||
| ``` | ||
|
|
||
| ## Component Usage | ||
|
|
||
| Import the `NotificationTraySlot` component and use it in your layout or header component where you want the notifications tray to appear: | ||
|
|
||
| ```jsx | ||
| import NotificationTraySlot from './src/plugin-slots/NotificationSlot'; | ||
|
|
||
| function Header() { | ||
| return ( | ||
| <header> | ||
| {/* Other header content */} | ||
| <NotificationTraySlot /> | ||
| </header> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| ## API | ||
|
|
||
| - **Slot ID:** `org.openedx.frontend.layout.notification_tray.v1` | ||
| - **Alias:** `notification_tray_plugin` | ||
| - **Component:** Uses the [PluginSlot](https://github.com/openedx/frontend-plugin-framework#pluginslot) from the Open edX Frontend Plugin Framework for plugin injection. | ||
| - **Props:** This component does not accept any props directly. | ||
|
|
||
| ## License | ||
|
|
||
| This component is part of the [open-craft/frontend-component-header](https://github.com/open-craft/frontend-component-header) repository and is made available under its license. | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you would like to contribute improvements or additional plugin slots, please open a pull request or issue in the [repository](https://github.com/open-craft/frontend-component-header). | ||
|
|
Binary file added
BIN
+20.2 KB
src/plugin-slots/NotificationSlot/images/learner_dashboard_notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+19.1 KB
src/plugin-slots/NotificationSlot/images/learner_header_notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+22.9 KB
src/plugin-slots/NotificationSlot/images/studio_header_notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,11 @@ | ||
| import React from 'react'; | ||
| import { PluginSlot } from '@openedx/frontend-plugin-framework'; | ||
|
|
||
| const NotificationTraySlot = () => ( | ||
| <PluginSlot | ||
| id="org.openedx.frontend.layout.notification_tray.v1" | ||
| idAliases={['notification_tray_plugin']} | ||
| /> | ||
| ); | ||
|
|
||
| export default NotificationTraySlot; | ||
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
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 not needed for a new slot.