Skip to content

chore: updated plugin slot configuration in ReadMe #39

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 20, 2025
Merged

chore: updated plugin slot configuration in ReadMe #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ frontend-plugin-notifications
Purpose
=======

This is the repository for storing Notification frontend plugin. Intended to be used with
This is the repository for storing Notification Tray frontend plugin. Intended to be used with
the `frontend-plugin-framework`_.

.. _frontend-plugin-framework: https://github.com/openedx/frontend-plugin-framework
Expand All @@ -31,53 +31,46 @@ Getting Started
Devstack Installation
---------------------

These plugins are intended to be used with Header component. Make sure to follow the instructions on the MFE's
This plugin is intended to be used with Header component. Make sure to follow the instructions on the MFE's
repository README for getting set up in a devstack.

Header in MFE should contain a plugin slot component to render the notifications tray.

Local Development
-----------------

Clone this repository into your main workspace folder.

Insert the following into the ``env.config.js`` file of MFE. If you haven't created one, create one
in the root that includes the following::

Insert the following into the ``env.config.js`` file of MFE. If it doesn't exist, create one
in the root and add the following configuration::

```
// Imports from frontend-plugin-framework
import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';

// Import plugin components from the npm package
import { Notifications, useAppNotifications } from '@edx/frontend-plugin-notifications';

// Component to render notifications
const NotificationsComponent = () => {
const { notificationAppData } = useAppNotifications();
return notificationAppData?.showNotificationsTray
? <Notifications notificationAppData={notificationAppData} />
: '';
};
import NotificationsTray from '@edx/frontend-plugin-notifications';

const config = {
pluginSlots: {

// Add configuration for each `notifications_slot`. This is the ID for the <PluginSlot> component
notifications_slot: {
// Add configuration for each notifications_slot. This is the ID for the <PluginSlot> component
notifications_tray: {
plugins: [
{
op: PLUGIN_OPERATIONS.Insert,
widget: {
id: 'notifications_tray',
type: DIRECT_PLUGIN,
RenderWidget: NotificationsComponent,
RenderWidget: NotificationsTray,
},
},
],
},
},
};

export default config;

```
Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

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

The code block uses markdown syntax (```) in an RST file. RST files should use RST code block syntax with :: directive instead.

Copilot uses AI. Check for mistakes.

Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

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

The code block closing uses markdown syntax (```) in an RST file. RST files should use proper RST formatting without explicit closing markers.

Copilot uses AI. Check for mistakes.


To develop while using this plugin library, modify the ``module.config.js`` file in the root of the MFE you are
developing in to reference the local version of the plugin.::
Expand Down