Skip to content

Commit 2b61517

Browse files
brian-smith-tcrilbrian-smith-tcril
authored
docs: update FPF slot information for Ulmo (#1336)
* docs: update available plugin slots page for ulmo * docs: add ulmo slots release notes page * fix: Apply suggestions from code review * chore: update links to use `:ref:` * chore: add maintenance chart info
1 parent bb0e293 commit 2b61517

3 files changed

Lines changed: 214 additions & 56 deletions

File tree

‎source/community/release_notes/ulmo/feature_release_notes.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Open edX Ulmo Release - Product Release Notes
1515
design_tokens
1616
stay_up_to_date
1717
ulmo_lti_cert
18+
ulmo_frontend_plugin_slots
1819

1920

2021
Information for site operators and developers, including information on how to

‎source/community/release_notes/ulmo/ulmo_frontend_plugin_slots.rst‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
.. _Ulmo Frontend Plugin Slots:
2+
3+
New Frontend Plugin Slots for the Ulmo Release
4+
###############################################
5+
6+
Utilizing *frontend plugin slots*, site operators now have the ability to
7+
customize various portions of the site.
8+
9+
A “frontend plugin slot” refers to an area of a web page - comprising one or
10+
more visual elements - that can be “swapped out” with other visual elements. For
11+
example, one plugin slot allows you to remove the "Help" button in the header.
12+
13+
Overhead and hassle is minimized using the plugin slot system. Site operators
14+
can leverage a plugin slot using a configuration file; the codebase does not
15+
need to be copied (“forked”) nor are extensive changes needed. A snippet of code
16+
is all that is needed to use a plugin slot. A site operator places that code
17+
within a configuration file. Site operators should refer to the
18+
``src/plugin-slots`` directory within each MFE's codebase to view documentation
19+
for that MFE's plugin slot(s).
20+
21+
In these release notes, we'll detail the new and updated plugin slots found in the Ulmo
22+
release. The full list of existing plugin slots can be found in
23+
:ref:`Available Frontend Plugin Slots`, and usage instructions are
24+
available at :ref:`Use A Frontend Plugin Framework Slot`.
25+
26+
.. contents::
27+
:local:
28+
:depth: 1
29+
30+
Where possible, descriptions of the plugin slots are provided. Click the name of
31+
the slot to be brought to the documentation page which contains example
32+
screenshots.
33+
34+
Note: Instance operators using these slots will need to use their
35+
fully-qualified slot id provided in the descriptions, such as
36+
``org.openedx.frontend.authoring.course_unit_sidebar.v1``.
37+
38+
Header
39+
************************************
40+
41+
* Added `DesktopUserMenuToggleSlot <https://github.com/openedx/frontend-component-header/tree/v8.1.0/src/plugin-slots/DesktopUserMenuToggleSlot>`_:
42+
This slot is used to replace/modify/hide the contents of the user menu toggle button on desktop sized screens.
43+
44+
* Added `LearningUserMenuToggleSlot <https://github.com/openedx/frontend-component-header/tree/v8.1.0/src/plugin-slots/LearningUserMenuToggleSlot>`_:
45+
This slot is used to replace/modify/hide the contents of the learning user menu toggle button.
46+
47+
* Added `MobileUserMenuToggleSlot <https://github.com/openedx/frontend-component-header/tree/v8.1.0/src/plugin-slots/MobileUserMenuToggleSlot>`_:
48+
This slot is used to replace/modify/hide the contents of the user menu toggle button on mobile screens.
49+
50+
* Added `StudioHeaderSearchButtonSlot <https://github.com/openedx/frontend-component-header/tree/v8.1.0/src/plugin-slots/StudioHeaderSearchButtonSlot>`_:
51+
This slot is used to replace/modify/hide the search button in the studio header.
52+
53+
54+
Footer
55+
************************************
56+
57+
* Added `StudioFooterHelpButtonSlot <https://github.com/openedx/frontend-component-footer/tree/v14.9.3/src/plugin-slots/StudioFooterHelpButtonSlot>`_:
58+
This slot is used to repace/modify/hide the help button in the studio footer.
59+
60+
* Added `StudioFooterHelpContentSlot <https://github.com/openedx/frontend-component-footer/tree/v14.9.3/src/plugin-slots/StudioFooterHelpContentSlot>`_:
61+
This slot is used to repace/modify/hide the help content in the studio footer.
62+
63+
* Added `StudioFooterHelpSectionSlot <https://github.com/openedx/frontend-component-footer/tree/v14.9.3/src/plugin-slots/StudioFooterHelpSectionSlot>`_:
64+
This slot is used to repace/modify/hide the help section in the studio footer.
65+
66+
* Updated `FooterSlot <https://github.com/openedx/frontend-component-footer/tree/v14.9.3/src/plugin-slots/FooterSlot>`_:
67+
New alias available.
68+
69+
70+
Account MFE
71+
************************************
72+
73+
* Added `AdditionalProfileFieldsSlot <https://github.com/openedx/frontend-app-account/tree/release/ulmo/src/plugin-slots/AdditionalProfileFieldsSlot>`_:
74+
This slot is used to replace/modify/hide the additional profile fields in the account page.
75+
76+
77+
Authoring MFE
78+
************************************
79+
80+
* Added v2 `CourseAuthoringUnitSidebarSlot <https://github.com/openedx/frontend-app-authoring/tree/release/ulmo/src/plugin-slots/CourseAuthoringUnitSidebarSlot>`_:
81+
The new version has improved handling of styling and conditional rendering.
82+
The v1 slot is also available and retains the previous behavior.
83+
84+
* Added `CourseFilesSlot <https://github.com/openedx/frontend-app-authoring/tree/release/ulmo/src/plugin-slots/CourseFilesSlot>`_:
85+
This slot is used to replace/modify/hide the course file table UI.
86+
87+
* Added `CourseOutlinePageAlertsSlot <https://github.com/openedx/frontend-app-authoring/tree/release/ulmo/src/plugin-slots/CourseOutlinePageAlertsSlot>`_:
88+
This slot is used to add alerts to the course outline page.
89+
90+
* Added `CourseVideosSlot <https://github.com/openedx/frontend-app-authoring/tree/release/ulmo/src/plugin-slots/CourseVideosSlot>`_:
91+
This slot is used to replace/modify/hide the course video upload page UI.
92+
93+
* Added `EditFileAlertsSlot <https://github.com/openedx/frontend-app-authoring/tree/release/ulmo/src/plugin-slots/EditFileAlertsSlot>`_:
94+
This slot is used to add alerts to the course file edit page.
95+
96+
* Added `EditVideoAlertsSlot <https://github.com/openedx/frontend-app-authoring/tree/release/ulmo/src/plugin-slots/EditVideoAlertsSlot>`_:
97+
This slot is used to add alerts to the course video edit page.
98+
99+
100+
Learning MFE
101+
*********************************************
102+
103+
* Added `ContentIFrameErrorSlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/ContentIFrameErrorSlot>`_:
104+
This slot is used to replace/modify the content iframe error page.
105+
106+
* Added `CourseExitViewCoursesPluginSlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/CourseExitPluginSlots/CourseExitViewCoursesPluginSlot>`_:
107+
This slot is used for modifying "View Courses" button in the course exit screen
108+
109+
* Added `DashboardFootnoteLinkPluginSlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/CourseExitPluginSlots/DashboardFootnoteLinkPluginSlot>`_:
110+
This slot is used for modifying the link to the learner dashboard in the footnote on the course exit page
111+
112+
* Added `SequenceNavigationSlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/SequenceNavigationSlot>`_:
113+
This slot is used to replace/modify/hide the sequence navigation component that controls navigation between units within a course sequence.
114+
115+
* Updated `CourseBreadcrumbsSlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/CourseBreadcrumbsSlot>`_:
116+
Added ``pluginProps``.
117+
118+
* Updated `NotificationTraySlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/NotificationTraySlot>`_:
119+
Added ``pluginProps``.
120+
121+
* Updated `UnitTitleSlot <https://github.com/openedx/frontend-app-learning/tree/release/ulmo/src/plugin-slots/UnitTitleSlot>`_:
122+
Modified ``pluginProps`` behavior, ``isEnabledOutlineSidebar`` is now always ``true``.
123+
124+
125+
.. seealso::
126+
127+
* :ref:`Use A Frontend Plugin Framework Slot`
128+
129+
* :ref:`Frontend Slots Learner Dash (Sumac)`
130+
131+
* :ref:`Frontend Slots Header (Sumac)`
132+
133+
**Maintenance chart**
134+
135+
+--------------+-------------------------------+----------------+--------------------------------+
136+
| Review Date | Working Group Reviewer | Release |Test situation |
137+
+--------------+-------------------------------+----------------+--------------------------------+
138+
| 2025-12-05 | Frontend WG | Ulmo | Pass |
139+
+--------------+-------------------------------+----------------+--------------------------------+

0 commit comments

Comments
 (0)