New Frontend Plugin Slots for the Ulmo Release#
Utilizing frontend plugin slots, site operators now have the ability to customize various portions of the site.
A “frontend plugin slot” refers to an area of a web page - comprising one or more visual elements - that can be “swapped out” with other visual elements. For example, one plugin slot allows you to remove the “Help” button in the header.
Overhead and hassle is minimized using the plugin slot system. Site operators
can leverage a plugin slot using a configuration file; the codebase does not
need to be copied (“forked”) nor are extensive changes needed. A snippet of code
is all that is needed to use a plugin slot. A site operator places that code
within a configuration file. Site operators should refer to the
src/plugin-slots directory within each MFE’s codebase to view documentation
for that MFE’s plugin slot(s).
In these release notes, we’ll detail the new and updated plugin slots found in the Ulmo release. The full list of existing plugin slots can be found in Available Frontend Plugin Slots, and usage instructions are available at Use A Frontend Plugin Framework Slot.
Where possible, descriptions of the plugin slots are provided. Click the name of the slot to be brought to the documentation page which contains example screenshots.
Note: Instance operators using these slots will need to use their
fully-qualified slot id provided in the descriptions, such as
org.openedx.frontend.authoring.course_unit_sidebar.v1.
Header#
Added DesktopUserMenuToggleSlot: This slot is used to replace/modify/hide the contents of the user menu toggle button on desktop sized screens.
Added LearningUserMenuToggleSlot: This slot is used to replace/modify/hide the contents of the learning user menu toggle button.
Added MobileUserMenuToggleSlot: This slot is used to replace/modify/hide the contents of the user menu toggle button on mobile screens.
Added StudioHeaderSearchButtonSlot: This slot is used to replace/modify/hide the search button in the studio header.
Account MFE#
Added AdditionalProfileFieldsSlot: This slot is used to replace/modify/hide the additional profile fields in the account page.
Learning MFE#
Added ContentIFrameErrorSlot: This slot is used to replace/modify the content iframe error page.
Added CourseExitViewCoursesPluginSlot: This slot is used for modifying “View Courses” button in the course exit screen
Added DashboardFootnoteLinkPluginSlot: This slot is used for modifying the link to the learner dashboard in the footnote on the course exit page
Added SequenceNavigationSlot: This slot is used to replace/modify/hide the sequence navigation component that controls navigation between units within a course sequence.
Updated CourseBreadcrumbsSlot: Added
pluginProps.Updated NotificationTraySlot: Added
pluginProps.Updated UnitTitleSlot: Modified
pluginPropsbehavior,isEnabledOutlineSidebaris now alwaystrue.
Catalog MFE#
Added org.openedx.frontend.catalog.home_page.banner: This slot is used to replace/modify/hide the entire Home page banner.
Added org.openedx.frontend.catalog.home_page.overlay_html: This slot is used to replace/modify/hide the entire Home page overlay HTML.
Added org.openedx.frontend.catalog.home_page.promo_video_button: This slot is used to replace/modify/hide the entire Home page promo video button.
Added org.openedx.frontend.catalog.home_page.promo_video_modal: This slot is used to replace/modify/hide the entire Course about page intro video modal.
Added org.openedx.frontend.catalog.home_page.promo_video_modal_content: This slot is used to replace/modify/hide the entire Course about page intro video modal content.
Added org.openedx.frontend.catalog.home_page.courses_list: This slot is used to replace/modify/hide the entire Home page courses list.
Added org.openedx.frontend.catalog.home_page.course_card: This slot is used to replace/modify/hide the entire Home page course card.
Added org.openedx.frontend.catalog.generic.loader: This slot is used to replace/modify/hide the entire content of a specified container during a loading state.
Added org.openedx.frontend.catalog.course_about_page.enrollment_button: This slot is used to replace/modify/hide the entire course enrollment button on the Course about page.
Added org.openedx.frontend.catalog.course_about_page.intro: This slot is used to replace/modify/hide the entire Course about page intro section.
Added org.openedx.frontend.catalog.course_about_page.intro_video_button: This slot is used to replace/modify/hide the entire Course about page video button.
Added org.openedx.frontend.catalog.course_about_page.intro_video_modal_content: This slot is used to replace/modify/hide the entire Course about page intro video modal content.
Added org.openedx.frontend.catalog.course_about_page.intro_video_modal: This slot is used to replace/modify/hide the entire Course about page intro video modal.
Added org.openedx.frontend.catalog.course_about_page.course_image: This slot is used to replace/modify/hide the entire Course about page course image.
Added org.openedx.frontend.catalog.course_about_page.course_media: This slot is used to replace/modify/hide the entire Course about page course media section.
Added org.openedx.frontend.catalog.course_about_page.sidebar: This slot is used to replace/modify/hide the entire Course about page sidebar.
Added org.openedx.frontend.catalog.course_catalog_page.intro: This slot is used to replace/modify/hide the entire Course catalog page intro section.
Added org.openedx.frontend.catalog.course_catalog_page.data_table.course_card: This slot is used to replace/modify/hide the entire Course catalog page data table course card.
Added org.openedx.frontend.catalog.course_catalog_page.data_table.card_view: This slot is used to replace/modify/hide the entire Course catalog page data table card view section.
Added org.openedx.frontend.catalog.course_catalog_page.data_table.control_bar: This slot is used to replace/modify/hide the entire Course catalog page data table control bar.
Added org.openedx.frontend.catalog.course_catalog_page.search_field: This slot is used to replace/modify/hide the entire Course catalog page search field.
Added org.openedx.frontend.catalog.course_catalog_page.data_table: This slot is used to replace/modify/hide the entire Course catalog page data table.
Added org.openedx.frontend.catalog.course_catalog_page.data_table.table_footer: This slot is used to replace/modify/hide the entire Course catalog page data table footer.
See also
Maintenance chart
Review Date |
Working Group Reviewer |
Release |
Test situation |
2025-12-05 |
Frontend WG |
Ulmo |
Pass |