Skip to content

Commit 374b18b

Browse files
feat: use FooterSlot component (#526)
1 parent 48c1255 commit 374b18b

File tree

6 files changed

+29
-12
lines changed

6 files changed

+29
-12
lines changed

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ This is the Learner Record micro-frontend, currently under development by `edX <
2424
Getting Started
2525
***************
2626

27+
Plugins
28+
=======
29+
This MFE can be customized using `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_.
30+
31+
The parts of this MFE that can be customized in that manner are documented `here </src/plugin-slots>`_.
32+
2733
Developing
2834
==========
2935

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
},
3636
"dependencies": {
3737
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
38-
"@edx/frontend-component-footer": "14.6.0",
38+
"@edx/frontend-component-footer": "^14.7.0",
3939
"@edx/frontend-component-header": "^6.2.0",
4040
"@edx/frontend-platform": "8.3.4",
4141
"@edx/openedx-atlas": "^0.7.0",

src/index.jsx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ import {
77
APP_INIT_ERROR, APP_READY, subscribe, initialize, mergeConfig, getConfig,
88
} from '@edx/frontend-platform';
99
import { AppProvider, ErrorPage, AuthenticatedPageRoute } from '@edx/frontend-platform/react';
10-
import { PluginSlot } from '@openedx/frontend-plugin-framework';
1110
import { HelmetProvider } from 'react-helmet-async';
1211
import Header from '@edx/frontend-component-header';
13-
import Footer from '@edx/frontend-component-footer';
12+
import { FooterSlot } from '@edx/frontend-component-footer';
1413

1514
import messages from './i18n';
1615
import './index.scss';
@@ -49,11 +48,7 @@ subscribe(APP_READY, () => {
4948
/>
5049
)}
5150
</Routes>
52-
<PluginSlot
53-
id="footer_plugin_slot"
54-
>
55-
<Footer />
56-
</PluginSlot>
51+
<FooterSlot />
5752
</HelmetProvider>
5853
</AppProvider>
5954
</StrictMode>,

src/plugin-slots/FooterSlot/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Footer Slot
2+
3+
### Slot ID: `org.openedx.frontend.layout.footer.v1`
4+
5+
### Slot ID Aliases
6+
* `footer_slot`
7+
* `footer_plugin_slot`
8+
9+
## Description
10+
11+
This slot is used to replace/modify/hide the footer.
12+
13+
The implementation of the `FooterSlot` component lives in [the `frontend-component-footer` repository](https://github.com/openedx/frontend-component-footer/).

src/plugin-slots/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# `frontend-app-learner-record` Plugin Slots
2+
3+
* [`org.openedx.frontend.layout.footer.v1`](./FooterSlot/)

0 commit comments

Comments
 (0)