Earliest Open edX Named Release Without This Functionality
Sumac - 2024-10
Rationale
Before the creation of frontend-plugin-framework the only officially supported (and technically viable) method for using a custom footer in MFEs was to fork the frontend-component-footer repository and install the forked footer using npm.
In the Redwood release support was added for footer replacement using frontend-plugin-framework/the FooterSlot component.
Footer replacement by npm installing a forked footer will no longer be supported.
This means that the Footer component (and the use of the Footer component in consuming MFEs) will no longer be an officially supported (implicit) API.
It will still be possible to replace the footer via npm install, but changes to frontend-component-footer and/or consuming MFEs that break existing forked footers but do not break the ability to replace the footer using frontend-plugin-framework and the FooterSlot component will not be reverted.
Proposal Date
2024-08-20
Target Ticket Acceptance Date
2024-09-03
Earliest Open edX Named Release Without This Functionality
Sumac - 2024-10
Rationale
Before the creation of
frontend-plugin-frameworkthe only officially supported (and technically viable) method for using a custom footer in MFEs was to fork thefrontend-component-footerrepository and install the forked footer usingnpm.In the Redwood release support was added for footer replacement using
frontend-plugin-framework/theFooterSlotcomponent.When building out that support we were required to make architectural decisions to continue to support the forking method of footer replacement. The initial idea was to have
frontend-component-footerprovide theFooterSlotcomponent. The implementation of this on the MFE side broke existing fork-based footer replacement, as MFEs expectedfrontend-component-footerto provide aFooterSlotcomponent that forked versions did not provide. This was reverted (MFE side,frontend-component-footerside) and theFooterSlotcomponent is now provided byfrontend-slot-footer.Removal
Footer replacement by
npm installing a forked footer will no longer be supported.This means that the
Footercomponent (and the use of theFootercomponent in consuming MFEs) will no longer be an officially supported (implicit) API.It will still be possible to replace the footer via
npm install, but changes tofrontend-component-footerand/or consuming MFEs that break existing forked footers but do not break the ability to replace the footer usingfrontend-plugin-frameworkand theFooterSlotcomponent will not be reverted.Replacement
Official support for footer replacement using
frontend-plugin-frameworkand theFooterSlotcomponent.Deprecation
No response
Migration
No response
Additional Info
No response
Task List
No response