frontend-component-footer

frontend-component-footer is a library containing a site footer component for use when building Open edX frontend applications.

Usage

To install frontend-component-footer into your project:

npm i --save @edx/frontend-component-footer

Component Usage:

import Footer, { messages } from '@edx/frontend-component-footer';

...

<Footer
   onLanguageSelected={(languageCode) => {/* set language */}}
   supportedLanguages={[
      { label: 'English', value: 'en'},
      { label: 'Español', value: 'es' },
   ]}
/>

• onLanguageSelected (optional)
• supportedLanguages (optional)

Styles (project.scss):

@import '@edx/frontend-component-footer/src/footer.scss';

Requirements

This component uses @edx/frontend-i18n. Any containing app must provide @edx/frontend-i18n as a peer dependency, and be wrapped inside an IntlProvider element, whether or not your consuming application is actually localized. For a basic default locale (English) version, follow the IntlProvider example in the sample application in src/index.jsx.

Development

Start the dev server:

npm i && npm start

Build the component:

npm run build