Compare commits
89 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
38d9a2076b | ||
|
|
a31d1a5387 | ||
|
|
a374cee7dd | ||
|
|
3f50a4d333 | ||
|
|
45f0f20f0f | ||
|
|
29a5db5e1a | ||
|
|
7982251640 | ||
|
|
9824aecd16 | ||
|
|
dcc361747e | ||
|
|
863ecb41bd | ||
|
|
f6d02d177d | ||
|
|
7e196f48cf | ||
|
|
46e4c78af8 | ||
|
|
affbcbeb19 | ||
|
|
8c10919eb9 | ||
|
|
314781ac0b | ||
|
|
b75ab299bd | ||
|
|
1fb4475b9a | ||
|
|
2b56d270a2 | ||
|
|
395c9240a0 | ||
|
|
60ceedced9 | ||
|
|
032e4dd73f | ||
|
|
212bc015ad | ||
|
|
d72eaa6fab | ||
|
|
1f5b74de21 | ||
|
|
07728e1498 | ||
|
|
5d44307136 | ||
|
|
1769069cfe | ||
|
|
2fb0cac399 | ||
|
|
807dc66714 | ||
|
|
ea837695e9 | ||
|
|
e4801b8b81 | ||
|
|
89337c4819 | ||
|
|
c75f6c079e | ||
|
|
77c251467c | ||
|
|
caba23d51b | ||
|
|
efbae26c56 | ||
|
|
efeacb8b73 | ||
|
|
a0865c9c56 | ||
|
|
7cfd6932d5 | ||
|
|
e2f92992b6 | ||
|
|
f37e6c164e | ||
|
|
fef30fb8b5 | ||
|
|
bcac04d0cc | ||
|
|
15ff0203ab | ||
|
|
940294d2a0 | ||
|
|
acd4a843a4 | ||
|
|
d8ee5425bf | ||
|
|
1d9e8d3c47 | ||
|
|
4d370f8a75 | ||
|
|
2a2be8eddb | ||
|
|
e7624adbfb | ||
|
|
5d0a418e85 | ||
|
|
f5b18cdd54 | ||
|
|
d5d290bcbe | ||
|
|
49c02c157b | ||
|
|
94b4aa7402 | ||
|
|
a9fe23287f | ||
|
|
30874b4972 | ||
|
|
14d53ef514 | ||
|
|
5c9270d88a | ||
|
|
f70ca27b34 | ||
|
|
d247e88541 | ||
|
|
ea257afcca | ||
|
|
24603cf98f | ||
|
|
4249bbc6df | ||
|
|
611beb8294 | ||
|
|
87803604b1 | ||
|
|
99344d93a4 | ||
|
|
2a718743ea | ||
|
|
4fe8909ad5 | ||
|
|
a0dc37dfb5 | ||
|
|
e4917030fa | ||
|
|
c756f42c28 | ||
|
|
1b6a5eda0b | ||
|
|
cbaf4bbb9e | ||
|
|
c990cbbf5e | ||
|
|
b41af87b8e | ||
|
|
a7d59a874c | ||
|
|
d66d3b7b62 | ||
|
|
7095e79471 | ||
|
|
4a9b3f2bfb | ||
|
|
e4d23d366b | ||
|
|
2e75cc95cb | ||
|
|
f64faf9f14 | ||
|
|
0be3098191 | ||
|
|
799cdb3b3c | ||
|
|
370ae52c04 | ||
|
|
5037a5610b |
19
.env.development
Normal file
19
.env.development
Normal file
@@ -0,0 +1,19 @@
|
||||
ACCESS_TOKEN_COOKIE_NAME=edx-jwt-cookie-header-payload
|
||||
BASE_URL=localhost:8080
|
||||
CREDENTIALS_BASE_URL=http://localhost:18150
|
||||
CSRF_TOKEN_API_PATH=/csrf/api/v1/token
|
||||
ECOMMERCE_BASE_URL=http://localhost:18130
|
||||
LANGUAGE_PREFERENCE_COOKIE_NAME=openedx-language-preference
|
||||
LMS_BASE_URL=http://localhost:18000
|
||||
LOGIN_URL=http://localhost:18000/login
|
||||
LOGOUT_URL=http://localhost:18000/login
|
||||
MARKETING_SITE_BASE_URL=http://localhost:18000
|
||||
ORDER_HISTORY_URL=localhost:1996/orders
|
||||
REFRESH_ACCESS_TOKEN_ENDPOINT=http://localhost:18000/login_refresh
|
||||
SEGMENT_KEY=null
|
||||
SITE_NAME=Open edX
|
||||
USER_INFO_COOKIE_NAME=edx-user-info
|
||||
LOGO_URL=https://edx-cdn.org/v3/default/logo.svg
|
||||
LOGO_TRADEMARK_URL=https://edx-cdn.org/v3/default/logo-trademark.svg
|
||||
LOGO_WHITE_URL=https://edx-cdn.org/v3/default/logo-white.svg
|
||||
FAVICON_URL=https://edx-cdn.org/v3/default/favicon.ico
|
||||
@@ -1,3 +1,4 @@
|
||||
coverage
|
||||
dist
|
||||
example
|
||||
node_modules
|
||||
|
||||
19
.github/workflows/add-depr-ticket-to-depr-board.yml
vendored
Normal file
19
.github/workflows/add-depr-ticket-to-depr-board.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
# Run the workflow that adds new tickets that are either:
|
||||
# - labelled "DEPR"
|
||||
# - title starts with "[DEPR]"
|
||||
# - body starts with "Proposal Date" (this is the first template field)
|
||||
# to the org-wide DEPR project board
|
||||
|
||||
name: Add newly created DEPR issues to the DEPR project board
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
|
||||
jobs:
|
||||
routeissue:
|
||||
uses: openedx/.github/.github/workflows/add-depr-ticket-to-depr-board.yml@master
|
||||
secrets:
|
||||
GITHUB_APP_ID: ${{ secrets.GRAPHQL_AUTH_APP_ID }}
|
||||
GITHUB_APP_PRIVATE_KEY: ${{ secrets.GRAPHQL_AUTH_APP_PEM }}
|
||||
SLACK_BOT_TOKEN: ${{ secrets.SLACK_ISSUE_BOT_TOKEN }}
|
||||
35
.github/workflows/ci.yml
vendored
Normal file
35
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
name: Default CI
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'master'
|
||||
pull_request:
|
||||
branches:
|
||||
- '**'
|
||||
jobs:
|
||||
tests:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
node: [12, 14, 16]
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Setup Nodejs
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: ${{ matrix.node }}
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Validate package-lock.json changes
|
||||
run: make validate-no-uncommitted-package-lock-changes
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
- name: Test
|
||||
run: npm run test
|
||||
- name: i18n_extract
|
||||
run: npm run i18n_extract
|
||||
- name: Coverage
|
||||
uses: codecov/codecov-action@v2
|
||||
10
.github/workflows/commitlint.yml
vendored
Normal file
10
.github/workflows/commitlint.yml
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
# Run commitlint on the commit messages in a pull request.
|
||||
|
||||
name: Lint Commit Messages
|
||||
|
||||
on:
|
||||
- pull_request
|
||||
|
||||
jobs:
|
||||
commitlint:
|
||||
uses: edx/.github/.github/workflows/commitlint.yml@master
|
||||
37
.github/workflows/release.yml
vendored
Normal file
37
.github/workflows/release.yml
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
name: Release CI
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v2
|
||||
with:
|
||||
node-version: 12
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
- name: Validate package-lock.json changes
|
||||
run: make validate-no-uncommitted-package-lock-changes
|
||||
- name: Lint
|
||||
run: npm run lint
|
||||
- name: Test
|
||||
run: npm run test
|
||||
- name: i18n_extract
|
||||
run: npm run i18n_extract
|
||||
- name: Coverage
|
||||
uses: codecov/codecov-action@v2
|
||||
- name: Build
|
||||
run: npm run build
|
||||
- name: Release
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN }}
|
||||
run: npx semantic-release
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -9,3 +9,4 @@ temp
|
||||
src/i18n/transifex_input.json
|
||||
temp/babel-plugin-react-intl
|
||||
/.vscode
|
||||
module.config.js
|
||||
|
||||
19
.travis.yml
19
.travis.yml
@@ -1,19 +0,0 @@
|
||||
language: node_js
|
||||
node_js: 12
|
||||
before_install:
|
||||
- npm install -g npm@6
|
||||
install:
|
||||
- npm install
|
||||
script:
|
||||
- make validate-no-uncommitted-package-lock-changes
|
||||
- npm run lint
|
||||
- npm run i18n_extract
|
||||
- npm run test
|
||||
- npm run build
|
||||
after_success:
|
||||
- npx semantic-release
|
||||
- codecov
|
||||
env:
|
||||
global:
|
||||
- secure: dxQadqP6tsoJzHcqs/Hs5AjE42z45q8ZeWKP5HcjbXoJURB4gc1uIxLky0FA6ZpulaTgRVTLcWQbx9yOODc9PQuFnFEDWlCg5EP8tONzeu7BVlJvV5eakgGUhl9w2pekBKsTGhK5dDg2y2D8bGfIL55UX81uiWeytp8s/y8QNs/FNXx9ScJnfhnC+2RfW52fB7iW12F1VYdQfVe43o5PsHze+YhB3FU/ztGe3iMaQiq9QplZWpvqQMpI7pTjyUAX8ITiiPS6UvLFObgpXpfjZdgd+yveFoi3z8o8F0NkmzBphFeSYFjFZE0qJ8bnGNIZldanMeuUgHmDeTwVmKQFhH2LqqnfcdGgW6UsKcHkSN1G51zzad2dEwAHrgxj1NkMp3JfEed2C7Kvntl6KRjVDmYZqHJvt+e+AHNbpjzblOW8tYMIrdz0TeJdk4D9pP3B3tRCtP6fvQ3GLzAMnaCrSsN6hZ9YVxWku8sg8WNEDHl14sZsdgk312MlHIdiUw97FHGrqx/NCix4IkUlCBDbKYbKzbZp20FfzZcwNRNH74+k6xpOnMGSfq8gByEhm9y02MBL76HiAI2VGct2La1ExaUfoikYGoNaZpFcZyOZKo6PYTYHpiUJmqrEnDyVQEOOXUaVsxWXwnYq/mU4nOEPKCRbNpPoksZdNxf6jlmMi8s=
|
||||
- secure: lrlV0WQaXTRJ2lqDkFZ+1RkRb7YM/STOViOHUNboXb5+1ReVwY0wklFDVk/Qigp3jkbqWfzkBmEjSDVGDLD61QjpGY4BsxZ/Jn3+KUdo0n82Ym6cI/je1fH2gqDLi4U8bylmnkI5oEjV/1txDxkj4hF5w/Leo/oGue3xQohpi//ihhm/PxzExj+QiDqyZPZ5RQZeqLfPEU3Wff04vLE5bRmy1nDTZrgm5Wb1n5ItGsyrUyrCGuAM9kIEun65Snb8hxCuU9pSm1w/xF73iOGLiiC8KZhLu6SxSKoC872ai1GpUXNIqA8kpVeH0Erf5opMtqJT3jTTan/VOFQEoOeAKhR0ga+5rfK2jkhhN77B98dGVndNCfBpDlgQxVv42H6riFk3payZT262QiUqDejiBDtSPTokTGxf7xFtQkQQahhxVXzC2HRKEkDTXNSP8cvk2JJ4zCcUgxJpycudLMuC/Xv0upK+Q0caItBrHxfVNnRKkjKqlDxRhA8nXTY8d2n19FNi7wahCECbyweJJ76EaJaa/Ib6remUBrbGLoQ2PkaSMBHAcn3+7+H/6x11b2s1RHj5qyfIyrvZcDDyNuxdXwpOkhtrkwZsjgtOfXL6IuxW5FExgPPr8B9nNwJJKdTxyxgfqtwBR5+m9nrMixzT6AMe95torZ6eX40gKZ/O9EU=
|
||||
@@ -1,8 +1,9 @@
|
||||
[main]
|
||||
host = https://www.transifex.com
|
||||
|
||||
[edx-platform.frontend-component-footer]
|
||||
[o:open-edx:p:edx-platform:r:frontend-component-footer]
|
||||
file_filter = src/i18n/messages/<lang>.json
|
||||
source_file = src/i18n/transifex_input.json
|
||||
source_lang = en
|
||||
type = KEYVALUEJSON
|
||||
type = KEYVALUEJSON
|
||||
|
||||
|
||||
2
Makefile
2
Makefile
@@ -50,7 +50,7 @@ push_translations:
|
||||
|
||||
# Pulls translations from Transifex.
|
||||
pull_translations:
|
||||
tx pull -f --mode reviewed --language=$(transifex_langs)
|
||||
tx pull -f --mode reviewed --languages=$(transifex_langs)
|
||||
|
||||
# This target is used by Travis.
|
||||
validate-no-uncommitted-package-lock-changes:
|
||||
|
||||
123
README.rst
123
README.rst
@@ -1,61 +1,96 @@
|
||||
#########################
|
||||
frontend-component-footer
|
||||
=========================
|
||||
#########################
|
||||
|
||||
|Build Status| |Coveralls| |npm_version| |npm_downloads| |license|
|
||||
|semantic-release|
|
||||
|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|
|
||||
|
||||
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';
|
||||
********
|
||||
Overview
|
||||
********
|
||||
|
||||
A generic footer for Open edX micro-frontend applications. It includes a logo and an optional language selector dropdown.
|
||||
|
||||
************
|
||||
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 <src/index.jsx>`__.
|
||||
This component uses ``@edx/frontend-platform`` services such as i18n, analytics, configuration, and the ``AppContext`` React component, and expects that it has been loaded into a micro-frontend that has been properly initialized via ``@edx/frontend-platform``'s ``initialize`` function. `Please visit the frontend template application to see an example. <https://github.com/edx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx>`_
|
||||
|
||||
Environment Variables
|
||||
=====================
|
||||
|
||||
This component requires that the following environment variable be set by the consuming micro-frontend.
|
||||
|
||||
* ``LMS_BASE_URL`` - The URL of the LMS of your Open edX instance.
|
||||
* ``LOGO_TRADEMARK_URL`` - This is a URL to a logo for use in the footer. This is a different environment variable than ``LOGO_URL`` (used in frontend-component-header) to accommodate sites that would like to have additional trademark information on a logo in the footer, such as a (tm) or (r) symbol.
|
||||
|
||||
************
|
||||
Installation
|
||||
************
|
||||
|
||||
To install this footer into your Open edX micro-frontend, run the following command in your MFE:
|
||||
|
||||
``npm i --save @edx/frontend-component-footer``
|
||||
|
||||
This will make the component available to be imported into your application.
|
||||
|
||||
*****
|
||||
Usage
|
||||
*****
|
||||
|
||||
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.
|
||||
|
||||
<Footer /> component props
|
||||
==========================
|
||||
|
||||
* onLanguageSelected: Provides the footer with an event handler for when the user selects a
|
||||
language from its dropdown.
|
||||
* supportedLanguages: An array of objects representing available languages. See example below for object shape.
|
||||
|
||||
Examples
|
||||
========
|
||||
|
||||
Component Usage Example::
|
||||
|
||||
import Footer, { messages } from '@edx/frontend-component-footer';
|
||||
|
||||
...
|
||||
|
||||
<Footer
|
||||
onLanguageSelected={(languageCode) => {/* set language */}}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en'},
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
|
||||
* `An example of minimal component and messages usage. <https://github.com/edx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx#L23>`_
|
||||
* `An example of SCSS file usage. <https://github.com/edx/frontend-template-application/blob/3cd5485bf387b8c479baf6b02bf59e3061dc3465/src/index.scss#L9>`_
|
||||
|
||||
***********
|
||||
Development
|
||||
-----------
|
||||
***********
|
||||
|
||||
Start the dev server::
|
||||
Install dependencies::
|
||||
|
||||
npm i && npm start
|
||||
npm i
|
||||
|
||||
Build the component::
|
||||
Start the development server::
|
||||
|
||||
npm run build
|
||||
npm start
|
||||
|
||||
.. |Build Status| image:: https://api.travis-ci.org/edx/frontend-component-footer.svg?branch=master
|
||||
:target: https://travis-ci.org/edx/frontend-component-footer
|
||||
.. |Coveralls| image:: https://img.shields.io/coveralls/edx/frontend-component-footer.svg?branch=master
|
||||
:target: https://coveralls.io/github/edx/frontend-component-footer
|
||||
Build a production distribution::
|
||||
|
||||
npm run build
|
||||
|
||||
.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-footer.svg?branch=master
|
||||
:target: https://travis-ci.com/edx/frontend-component-footer
|
||||
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-footer
|
||||
:target: @edx/frontend-component-footer
|
||||
.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-footer.svg
|
||||
:target: @edx/frontend-component-footer
|
||||
.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-footer.svg
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
module.exports = {
|
||||
extends: ['@commitlint/config-angular'],
|
||||
};
|
||||
@@ -1,22 +1,33 @@
|
||||
import 'babel-polyfill';
|
||||
|
||||
import React from 'react';
|
||||
import { render } from 'react-dom';
|
||||
import { IntlProvider } from '@edx/frontend-platform/i18n';
|
||||
import ReactDOM from 'react-dom';
|
||||
import { initialize, getConfig, subscribe, APP_READY } from '@edx/frontend-platform';
|
||||
import { AppContext, AppProvider } from '@edx/frontend-platform/react';
|
||||
import Footer from '@edx/frontend-component-footer';
|
||||
|
||||
import './index.scss';
|
||||
import Footer from '../src';
|
||||
|
||||
const App = () => (
|
||||
<div>
|
||||
<IntlProvider locale="en">
|
||||
<Footer
|
||||
onLanguageSelected={() => {}}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en' },
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
</IntlProvider>
|
||||
</div>
|
||||
);
|
||||
subscribe(APP_READY, () => {
|
||||
ReactDOM.render(
|
||||
<AppProvider>
|
||||
<AppContext.Provider value={{
|
||||
authenticatedUser: null,
|
||||
config: getConfig(),
|
||||
}}>
|
||||
<Footer
|
||||
onLanguageSelected={() => {}}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en' },
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
</AppContext.Provider>
|
||||
</AppProvider>,
|
||||
document.getElementById('root'),
|
||||
);
|
||||
});
|
||||
|
||||
render(<App />, document.getElementById('root'));
|
||||
initialize({
|
||||
messages: []
|
||||
});
|
||||
|
||||
@@ -1,2 +1,6 @@
|
||||
@import "~@edx/paragon/scss/core/core.scss";
|
||||
@import "../src/footer";
|
||||
@import "@edx/brand/paragon/fonts";
|
||||
@import "@edx/brand/paragon/variables";
|
||||
@import "@edx/paragon/scss/core/core";
|
||||
@import "@edx/brand/paragon/overrides";
|
||||
|
||||
@import "@edx/frontend-component-footer/footer";
|
||||
|
||||
53886
package-lock.json
generated
53886
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
47
package.json
47
package.json
@@ -19,8 +19,7 @@
|
||||
],
|
||||
"husky": {
|
||||
"hooks": {
|
||||
"pre-commit": "npm run lint",
|
||||
"commit-msg": "commitlint -e $GIT_PARAMS"
|
||||
"pre-commit": "npm run lint"
|
||||
}
|
||||
},
|
||||
"repository": {
|
||||
@@ -34,33 +33,33 @@
|
||||
},
|
||||
"homepage": "https://github.com/edx/frontend-component-footer#readme",
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "8.2.0",
|
||||
"@commitlint/config-angular": "8.2.0",
|
||||
"@commitlint/prompt": "8.2.0",
|
||||
"@commitlint/prompt-cli": "8.2.0",
|
||||
"@edx/frontend-build": "^2.0.4",
|
||||
"@edx/frontend-platform": "1.1.6",
|
||||
"@edx/paragon": "7.1.5",
|
||||
"codecov": "3.6.5",
|
||||
"enzyme": "3.10.0",
|
||||
"enzyme-adapter-react-16": "1.14.0",
|
||||
"husky": "3.0.9",
|
||||
"@edx/brand": "npm:@edx/brand-openedx@1.1.0",
|
||||
"@edx/frontend-build": "9.1.4",
|
||||
"@edx/frontend-platform": "^1.15.1",
|
||||
"@edx/paragon": "^19.6.0",
|
||||
"codecov": "3.8.3",
|
||||
"enzyme": "3.11.0",
|
||||
"enzyme-adapter-react-16": "1.15.6",
|
||||
"husky": "7.0.4",
|
||||
"prop-types": "15.7.2",
|
||||
"react": "16.10.2",
|
||||
"react-dom": "16.10.2",
|
||||
"react-test-renderer": "16.10.2",
|
||||
"reactifex": "1.1.1"
|
||||
"react": "16.14.0",
|
||||
"react-dom": "16.14.0",
|
||||
"react-redux": "7.2.8",
|
||||
"react-router-dom": "5.3.0",
|
||||
"react-test-renderer": "16.14.0",
|
||||
"reactifex": "1.1.1",
|
||||
"redux": "4.1.2",
|
||||
"semantic-release": "^17.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-svg-core": "1.2.28",
|
||||
"@fortawesome/free-brands-svg-icons": "5.8.2",
|
||||
"@fortawesome/free-regular-svg-icons": "5.8.2",
|
||||
"@fortawesome/free-solid-svg-icons": "5.8.2",
|
||||
"@fortawesome/react-fontawesome": "0.1.9"
|
||||
"@fortawesome/fontawesome-svg-core": "1.2.36",
|
||||
"@fortawesome/free-brands-svg-icons": "5.15.4",
|
||||
"@fortawesome/free-regular-svg-icons": "5.15.4",
|
||||
"@fortawesome/free-solid-svg-icons": "5.15.4",
|
||||
"@fortawesome/react-fontawesome": "0.1.18"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@edx/frontend-platform": "^1.1.4",
|
||||
"@edx/paragon": "^7.0.0",
|
||||
"@edx/frontend-platform": "^1.8.0",
|
||||
"prop-types": "^15.5.10",
|
||||
"react": "^16.9.0",
|
||||
"react-dom": "^16.9.0"
|
||||
|
||||
@@ -1,9 +1,28 @@
|
||||
{
|
||||
"extends": [
|
||||
"config:base"
|
||||
"config:base",
|
||||
"schedule:weekly",
|
||||
":automergeLinters",
|
||||
":automergeMinor",
|
||||
":automergeTesters",
|
||||
":enableVulnerabilityAlerts",
|
||||
":rebaseStalePrs",
|
||||
":semanticCommits",
|
||||
":updateNotScheduled"
|
||||
],
|
||||
"patch": {
|
||||
"automerge": true
|
||||
},
|
||||
"rebaseStalePrs": true
|
||||
"packageRules": [
|
||||
{
|
||||
"matchDepTypes": [
|
||||
"devDependencies"
|
||||
],
|
||||
"matchUpdateTypes": [
|
||||
"lockFileMaintenance",
|
||||
"minor",
|
||||
"patch",
|
||||
"pin"
|
||||
],
|
||||
"automerge": true
|
||||
}
|
||||
],
|
||||
"timezone": "America/New_York"
|
||||
}
|
||||
|
||||
@@ -2,11 +2,17 @@ import React from 'react';
|
||||
import PropTypes from 'prop-types';
|
||||
import { injectIntl, intlShape } from '@edx/frontend-platform/i18n';
|
||||
import { sendTrackEvent } from '@edx/frontend-platform/analytics';
|
||||
import { ensureConfig } from '@edx/frontend-platform/config';
|
||||
import { AppContext } from '@edx/frontend-platform/react';
|
||||
|
||||
import messages from './Footer.messages';
|
||||
import FooterLogo from '../edx-openedx-logo-tag.png';
|
||||
import LanguageSelector from './LanguageSelector';
|
||||
|
||||
ensureConfig([
|
||||
'LMS_BASE_URL',
|
||||
'LOGO_TRADEMARK_URL',
|
||||
], 'Footer component');
|
||||
|
||||
const EVENT_NAMES = {
|
||||
FOOTER_LINK: 'edx.bi.footer.link',
|
||||
};
|
||||
@@ -43,38 +49,40 @@ class SiteFooter extends React.Component {
|
||||
intl,
|
||||
} = this.props;
|
||||
const showLanguageSelector = supportedLanguages.length > 0 && onLanguageSelected;
|
||||
const { config } = this.context;
|
||||
|
||||
return (
|
||||
<footer
|
||||
role="contentinfo"
|
||||
aria-label={intl.formatMessage(messages['footer.logo.ariaLabel'])}
|
||||
className="footer d-flex border-top py-3 px-4"
|
||||
>
|
||||
<div className="container d-flex">
|
||||
<div className="container-fluid d-flex">
|
||||
<a
|
||||
className="d-block mb-3"
|
||||
href="https://open.edx.org"
|
||||
className="d-block"
|
||||
href={config.LMS_BASE_URL}
|
||||
aria-label={intl.formatMessage(messages['footer.logo.ariaLabel'])}
|
||||
>
|
||||
<img
|
||||
style={{ maxWidth: 150 }}
|
||||
src={logo || FooterLogo}
|
||||
style={{ maxHeight: 45 }}
|
||||
src={logo || config.LOGO_TRADEMARK_URL}
|
||||
alt={intl.formatMessage(messages['footer.logo.altText'])}
|
||||
/>
|
||||
</a>
|
||||
<div className="flex-grow-1" />
|
||||
{showLanguageSelector &&
|
||||
{showLanguageSelector && (
|
||||
<LanguageSelector
|
||||
options={supportedLanguages}
|
||||
onSubmit={onLanguageSelected}
|
||||
/>
|
||||
}
|
||||
)}
|
||||
</div>
|
||||
</footer>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
SiteFooter.contextType = AppContext;
|
||||
|
||||
SiteFooter.propTypes = {
|
||||
intl: intlShape.isRequired,
|
||||
logo: PropTypes.string,
|
||||
|
||||
@@ -2,6 +2,7 @@ import React from 'react';
|
||||
import renderer from 'react-test-renderer';
|
||||
import { mount } from 'enzyme';
|
||||
import { IntlProvider } from '@edx/frontend-platform/i18n';
|
||||
import { AppContext } from '@edx/frontend-platform/react';
|
||||
|
||||
import Footer from './Footer';
|
||||
|
||||
@@ -11,7 +12,17 @@ describe('<Footer />', () => {
|
||||
const tree = renderer
|
||||
.create((
|
||||
<IntlProvider locale="en">
|
||||
<Footer />
|
||||
<AppContext.Provider
|
||||
value={{
|
||||
authenticatedUser: null,
|
||||
config: {
|
||||
LOGO_TRADEMARK_URL: process.env.LOGO_TRADEMARK_URL,
|
||||
LMS_BASE_URL: process.env.LMS_BASE_URL,
|
||||
},
|
||||
}}
|
||||
>
|
||||
<Footer />
|
||||
</AppContext.Provider>
|
||||
</IntlProvider>
|
||||
))
|
||||
.toJSON();
|
||||
@@ -21,7 +32,17 @@ describe('<Footer />', () => {
|
||||
const tree = renderer
|
||||
.create((
|
||||
<IntlProvider locale="es">
|
||||
<Footer />
|
||||
<AppContext.Provider
|
||||
value={{
|
||||
authenticatedUser: null,
|
||||
config: {
|
||||
LOGO_TRADEMARK_URL: process.env.LOGO_TRADEMARK_URL,
|
||||
LMS_BASE_URL: process.env.LMS_BASE_URL,
|
||||
},
|
||||
}}
|
||||
>
|
||||
<Footer />
|
||||
</AppContext.Provider>
|
||||
</IntlProvider>
|
||||
))
|
||||
.toJSON();
|
||||
@@ -31,13 +52,23 @@ describe('<Footer />', () => {
|
||||
const tree = renderer
|
||||
.create((
|
||||
<IntlProvider locale="en">
|
||||
<Footer
|
||||
onLanguageSelected={() => {}}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en' },
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
<AppContext.Provider
|
||||
value={{
|
||||
authenticatedUser: null,
|
||||
config: {
|
||||
LOGO_TRADEMARK_URL: process.env.LOGO_TRADEMARK_URL,
|
||||
LMS_BASE_URL: process.env.LMS_BASE_URL,
|
||||
},
|
||||
}}
|
||||
>
|
||||
<Footer
|
||||
onLanguageSelected={() => {}}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en' },
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
</AppContext.Provider>
|
||||
</IntlProvider>
|
||||
))
|
||||
.toJSON();
|
||||
@@ -50,13 +81,23 @@ describe('<Footer />', () => {
|
||||
const mockHandleLanguageSelected = jest.fn();
|
||||
const wrapper = mount((
|
||||
<IntlProvider locale="en">
|
||||
<Footer
|
||||
onLanguageSelected={mockHandleLanguageSelected}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en' },
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
<AppContext.Provider
|
||||
value={{
|
||||
authenticatedUser: null,
|
||||
config: {
|
||||
LOGO_TRADEMARK_URL: process.env.LOGO_TRADEMARK_URL,
|
||||
LMS_BASE_URL: process.env.LMS_BASE_URL,
|
||||
},
|
||||
}}
|
||||
>
|
||||
<Footer
|
||||
onLanguageSelected={mockHandleLanguageSelected}
|
||||
supportedLanguages={[
|
||||
{ label: 'English', value: 'en' },
|
||||
{ label: 'Español', value: 'es' },
|
||||
]}
|
||||
/>
|
||||
</AppContext.Provider>
|
||||
</IntlProvider>
|
||||
));
|
||||
|
||||
|
||||
@@ -17,8 +17,8 @@ const LanguageSelector = ({
|
||||
onSubmit={handleSubmit}
|
||||
{...props}
|
||||
>
|
||||
{/* eslint-disable-next-line jsx-a11y/label-has-for */}
|
||||
<div className="form-group">
|
||||
{/* eslint-disable-next-line jsx-a11y/label-has-associated-control */}
|
||||
<label htmlFor="site-footer-language-select" className="d-inline-block m-0">
|
||||
<FormattedMessage
|
||||
id="footer.languageForm.select.label"
|
||||
@@ -32,8 +32,7 @@ const LanguageSelector = ({
|
||||
name="site-footer-language-select"
|
||||
defaultValue={intl.locale}
|
||||
>
|
||||
{options.map(({ value, label }) =>
|
||||
<option key={value} value={value}>{label}</option>)}
|
||||
{options.map(({ value, label }) => <option key={value} value={value}>{label}</option>)}
|
||||
</select>
|
||||
<button className="btn btn-outline-primary btn-sm" type="submit">
|
||||
<FormattedMessage
|
||||
|
||||
@@ -2,24 +2,23 @@
|
||||
|
||||
exports[`<Footer /> renders correctly renders with a language selector 1`] = `
|
||||
<footer
|
||||
aria-label="edX Home"
|
||||
className="footer d-flex border-top py-3 px-4"
|
||||
role="contentinfo"
|
||||
>
|
||||
<div
|
||||
className="container d-flex"
|
||||
className="container-fluid d-flex"
|
||||
>
|
||||
<a
|
||||
aria-label="edX Home"
|
||||
className="d-block mb-3"
|
||||
href="https://open.edx.org"
|
||||
className="d-block"
|
||||
href="http://localhost:18000"
|
||||
>
|
||||
<img
|
||||
alt="Powered by Open edX"
|
||||
src="test-file-stub"
|
||||
src="https://edx-cdn.org/v3/default/logo-trademark.svg"
|
||||
style={
|
||||
Object {
|
||||
"maxWidth": 150,
|
||||
"maxHeight": 45,
|
||||
}
|
||||
}
|
||||
/>
|
||||
@@ -75,24 +74,23 @@ exports[`<Footer /> renders correctly renders with a language selector 1`] = `
|
||||
|
||||
exports[`<Footer /> renders correctly renders without a language selector 1`] = `
|
||||
<footer
|
||||
aria-label="edX Home"
|
||||
className="footer d-flex border-top py-3 px-4"
|
||||
role="contentinfo"
|
||||
>
|
||||
<div
|
||||
className="container d-flex"
|
||||
className="container-fluid d-flex"
|
||||
>
|
||||
<a
|
||||
aria-label="edX Home"
|
||||
className="d-block mb-3"
|
||||
href="https://open.edx.org"
|
||||
className="d-block"
|
||||
href="http://localhost:18000"
|
||||
>
|
||||
<img
|
||||
alt="Powered by Open edX"
|
||||
src="test-file-stub"
|
||||
src="https://edx-cdn.org/v3/default/logo-trademark.svg"
|
||||
style={
|
||||
Object {
|
||||
"maxWidth": 150,
|
||||
"maxHeight": 45,
|
||||
}
|
||||
}
|
||||
/>
|
||||
@@ -106,24 +104,23 @@ exports[`<Footer /> renders correctly renders without a language selector 1`] =
|
||||
|
||||
exports[`<Footer /> renders correctly renders without a language selector in es 1`] = `
|
||||
<footer
|
||||
aria-label="edX Home"
|
||||
className="footer d-flex border-top py-3 px-4"
|
||||
role="contentinfo"
|
||||
>
|
||||
<div
|
||||
className="container d-flex"
|
||||
className="container-fluid d-flex"
|
||||
>
|
||||
<a
|
||||
aria-label="edX Home"
|
||||
className="d-block mb-3"
|
||||
href="https://open.edx.org"
|
||||
className="d-block"
|
||||
href="http://localhost:18000"
|
||||
>
|
||||
<img
|
||||
alt="Powered by Open edX"
|
||||
src="test-file-stub"
|
||||
src="https://edx-cdn.org/v3/default/logo-trademark.svg"
|
||||
style={
|
||||
Object {
|
||||
"maxWidth": 150,
|
||||
"maxHeight": 45,
|
||||
}
|
||||
}
|
||||
/>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB |
@@ -2,3 +2,25 @@ import Enzyme from 'enzyme';
|
||||
import Adapter from 'enzyme-adapter-react-16';
|
||||
|
||||
Enzyme.configure({ adapter: new Adapter() });
|
||||
|
||||
// These configuration values are usually set in webpack's EnvironmentPlugin however
|
||||
// Jest does not use webpack so we need to set these so for testing
|
||||
process.env.ACCESS_TOKEN_COOKIE_NAME = 'edx-jwt-cookie-header-payload';
|
||||
process.env.BASE_URL = 'localhost:1995';
|
||||
process.env.CREDENTIALS_BASE_URL = 'http://localhost:18150';
|
||||
process.env.CSRF_TOKEN_API_PATH = '/csrf/api/v1/token';
|
||||
process.env.ECOMMERCE_BASE_URL = 'http://localhost:18130';
|
||||
process.env.LANGUAGE_PREFERENCE_COOKIE_NAME = 'openedx-language-preference';
|
||||
process.env.LMS_BASE_URL = 'http://localhost:18000';
|
||||
process.env.LOGIN_URL = 'http://localhost:18000/login';
|
||||
process.env.LOGOUT_URL = 'http://localhost:18000/login';
|
||||
process.env.MARKETING_SITE_BASE_URL = 'http://localhost:18000';
|
||||
process.env.ORDER_HISTORY_URL = 'localhost:1996/orders';
|
||||
process.env.REFRESH_ACCESS_TOKEN_ENDPOINT = 'http://localhost:18000/login_refresh';
|
||||
process.env.SEGMENT_KEY = 'segment_whoa';
|
||||
process.env.SITE_NAME = 'edX';
|
||||
process.env.USER_INFO_COOKIE_NAME = 'edx-user-info';
|
||||
process.env.LOGO_URL = 'https://edx-cdn.org/v3/default/logo.svg';
|
||||
process.env.LOGO_TRADEMARK_URL = 'https://edx-cdn.org/v3/default/logo-trademark.svg';
|
||||
process.env.LOGO_WHITE_URL = 'https://edx-cdn.org/v3/default/logo-white.svg';
|
||||
process.env.FAVICON_URL = 'https://edx-cdn.org/v3/default/favicon.ico';
|
||||
|
||||
@@ -7,4 +7,9 @@ module.exports = createConfig('webpack-dev', {
|
||||
path: path.resolve(__dirname, 'example/dist'),
|
||||
publicPath: '/',
|
||||
},
|
||||
resolve: {
|
||||
alias: {
|
||||
'@edx/frontend-component-footer': path.resolve(__dirname, 'src'),
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user