Skip to content

Commit

Permalink
fix!: remove FooterSlot component
Browse files Browse the repository at this point in the history
BREAKING CHANGE: the `FooterSlot` component will now be provided by `frontend-slot-footer`.
  • Loading branch information
brian-smith-tcril authored and arbrandes committed May 14, 2024
1 parent 5f7fab2 commit ea2578f
Show file tree
Hide file tree
Showing 8 changed files with 3 additions and 76 deletions.
5 changes: 2 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ This library has the following exports:
* ``(default)``: The footer as a React component.
* ``messages``: Internationalization messages suitable for use with `@edx/frontend-platform/i18n <https://edx.github.io/frontend-platform/module-Internationalization.html>`_
* ``dist/footer.scss``: A SASS file which contains style information for the component. It should be imported into the micro-frontend's own SCSS file.
* ``FooterSlot``: The footer wrapped in a `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_ ``PluginSlot``.

<Footer /> component props
==========================
Expand All @@ -96,9 +95,9 @@ This library has the following exports:

Plugin
======
This package provides a wrapped version of the footer using `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_.
The footer can be replaced using using `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_.

Information on how to utilize the ``FooterSlot`` is available `here </src/components/footer-slot>`_.
Information on how to utilize the ``FooterSlot`` component to do so is available in the `frontend-slot-footer repository <https://github.com/openedx/frontend-slot-footer/>`_.

Examples
========
Expand Down
6 changes: 0 additions & 6 deletions package-lock.json

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

6 changes: 0 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,9 @@
},
"peerDependencies": {
"@edx/frontend-platform": "^7.0.0 || ^8.0.0",
"@openedx/frontend-plugin-framework": "^1.1.2",
"@openedx/paragon": ">= 21.11.3 < 23.0.0",
"prop-types": "^15.5.10",
"react": "^16.9.0 || ^17.0.0",
"react-dom": "^16.9.0 || ^17.0.0"
},
"peerDependenciesMeta": {
"@openedx/frontend-plugin-framework": {
"optional": true
}
}
}
48 changes: 0 additions & 48 deletions src/components/footer-slot/README.md

This file was deleted.

Binary file removed src/components/footer-slot/images/custom_footer.png
Binary file not shown.
Binary file removed src/components/footer-slot/images/default_footer.png
Binary file not shown.
11 changes: 0 additions & 11 deletions src/components/footer-slot/index.jsx

This file was deleted.

3 changes: 1 addition & 2 deletions src/index.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import Footer, { EVENT_NAMES } from './components/Footer';
import messages from './i18n/index';
import StudioFooter from './components/studio-footer';
import FooterSlot from './components/footer-slot';

export default Footer;
export {
messages, EVENT_NAMES, StudioFooter, FooterSlot,
messages, EVENT_NAMES, StudioFooter,
};

0 comments on commit ea2578f

Please sign in to comment.