Skip to content

feat: use FooterSlot component #526

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
brian-smith-tcril merged 1 commit into from
Apr 24, 2025
Merged

feat: use FooterSlot component #526

Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ This is the Learner Record micro-frontend, currently under development by `edX <
Getting Started
***************

Plugins
=======
This MFE can be customized using `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_.

The parts of this MFE that can be customized in that manner are documented `here </src/plugin-slots>`_.

Developing
==========

Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
},
"dependencies": {
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
"@edx/frontend-component-footer": "14.6.0",
"@edx/frontend-component-footer": "^14.7.0",
"@edx/frontend-component-header": "^6.2.0",
"@edx/frontend-platform": "8.3.4",
"@edx/openedx-atlas": "^0.7.0",
Expand Down
9 changes: 2 additions & 7 deletions src/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ import {
APP_INIT_ERROR, APP_READY, subscribe, initialize, mergeConfig, getConfig,
} from '@edx/frontend-platform';
import { AppProvider, ErrorPage, AuthenticatedPageRoute } from '@edx/frontend-platform/react';
import { PluginSlot } from '@openedx/frontend-plugin-framework';
import { HelmetProvider } from 'react-helmet-async';
import Header from '@edx/frontend-component-header';
import Footer from '@edx/frontend-component-footer';
import { FooterSlot } from '@edx/frontend-component-footer';

import messages from './i18n';
import './index.scss';
Expand Down Expand Up @@ -49,11 +48,7 @@ subscribe(APP_READY, () => {
/>
)}
</Routes>
<PluginSlot
id="footer_plugin_slot"
>
<Footer />
</PluginSlot>
<FooterSlot />
</HelmetProvider>
</AppProvider>
</StrictMode>,
Expand Down
13 changes: 13 additions & 0 deletions src/plugin-slots/FooterSlot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Footer Slot

### Slot ID: `org.openedx.frontend.layout.footer.v1`

### Slot ID Aliases
* `footer_slot`
* `footer_plugin_slot`

## Description

This slot is used to replace/modify/hide the footer.

The implementation of the `FooterSlot` component lives in [the `frontend-component-footer` repository](https://github.com/openedx/frontend-component-footer/).
3 changes: 3 additions & 0 deletions src/plugin-slots/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `frontend-app-learner-record` Plugin Slots

* [`org.openedx.frontend.layout.footer.v1`](./FooterSlot/)