...
| Note |
|---|
This has been moved to the docs site https://github.com/openedx/docs.openedx.org/pull/594 |
Utilizing frontend plugin slots, site operators now have the ability to customize various aspects of an instance’s site header.
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 new plugin slot allows you to “swap out” the link that the header logo goes to (or remove it entirely).
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).
| Table of Contents | ||
|---|---|---|
|
Header Slot
Capabilities
explain what it can do, with screenshots
Leveraging This Slot
Could add some “advanced” use cases. Should basically though point at the developer docs
Enabling this slot is done via backend administrationThis slot can be utilized via code-based configuration. Site operators should consult the <LINK>header plugin slot documentation</LINK> for examples of how to use this slot.
...
New Slot Template
Capabilities
The “course card” is what represents a course on the learner dashboard - it contains the course thumbnail, name, passing requirements, and other information. It also contains an “Upgrade” button:
This Upgrade button (or more generally, the “Action” button) is now a plugin slot! This means that the button can easily be removed, changed, or even added to. This example below shows how an instance might remove the Upgrade button and instead add two custom action buttons:
explain what it can do, with screenshots
Leveraging This Slot
Could add some “advanced” use cases. Should basically though point at the developer docs
Enabling this slot is done via backend administrationThis slot can be utilized via code-based configuration. Site operators should consult the Learner Dashboard <LINK>header plugin slot documentationdocumentation</LINK> for examples of how to use this slot.
Another Slot if one happens
Capabilities
explain what it can do, with screenshots
Leveraging This Slot
Could add some “advanced” use cases. Should basically though point at the developer docs