Compare commits

...

59 Commits

Author SHA1 Message Date
renovate[bot]
0015b72eb7 fix(deps): update font awesome to v6.5.1 2023-12-04 14:14:17 +00:00
renovate[bot]
f694e322ee chore(deps): update dependency react-router-dom to v6.20.1 2023-12-04 10:33:49 +00:00
renovate[bot]
5e7ac40348 chore(deps): update dependency react-router-dom to v6.20.0 2023-11-27 12:52:56 +00:00
renovate[bot]
c2e5f0f403 chore(deps): update dependency @edx/frontend-platform to v6.1.1 2023-11-27 11:31:56 +00:00
renovate[bot]
d0b9a40f5d chore(deps): update dependency react-router-dom to v6.19.0 2023-11-20 12:22:39 +00:00
renovate[bot]
3f815b386f chore(deps): update dependency @edx/frontend-build to v13.0.8 2023-11-20 10:06:43 +00:00
renovate[bot]
e9bb918925 chore(deps): update actions/checkout action to v4 (#336)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-11-16 12:21:39 +05:00
renovate[bot]
9b1a3e994a chore(deps): update actions/setup-node action to v4 (#364)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-11-16 11:44:27 +05:00
Bilal Qamar
7253f9de2b feat: bumped frontend-platform version (#367) 2023-11-15 17:30:54 +05:00
Bilal Qamar
3e6ccb2ea1 Revert "chore: bumped frontend-platform version (#365)" (#366)
This reverts commit 7c3c925838.
2023-11-15 17:11:08 +05:00
Bilal Qamar
7c3c925838 chore: bumped frontend-platform version (#365) 2023-11-15 16:51:39 +05:00
renovate[bot]
cde76129af chore(deps): update dependency @edx/frontend-build to v13.0.5 2023-11-13 10:09:37 +00:00
renovate[bot]
29050d109f chore(deps): update dependency react-router-dom to v6.18.0 2023-11-06 16:36:59 +00:00
renovate[bot]
5caf0ea549 chore(deps): update dependency @edx/frontend-build to v13.0.4 2023-11-06 11:19:32 +00:00
renovate[bot]
3571e5c3ed fix(deps): update dependency @edx/paragon to v21.5.6 2023-10-30 14:35:46 +00:00
renovate[bot]
1011854f51 chore(deps): update dependency react-router-dom to v6.17.0 2023-10-30 09:35:57 +00:00
renovate[bot]
a5859702b5 chore(deps): update dependency @edx/frontend-build to v13.0.3 2023-10-30 07:46:50 +00:00
Bilal Qamar
2b3a13a5a0 chore: bumped frontend-platform version (#356) 2023-10-24 13:58:44 +05:00
Feanil Patel
ca4b4905b7 chore: Update to the new version of brand-openedx in the new scope. (#354)
Part of https://github.com/openedx/axim-engineering/issues/23

This updates the `@edx/brand` alias to point to the `brand-openedx` package at
the `openedx` scope. This does not impact imports because this package is used
via an alias.
2023-10-20 17:17:37 -04:00
dependabot[bot]
c7e42fda3d build(deps-dev): bump @babel/traverse from 7.22.5 to 7.23.2 (#353)
Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.22.5 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-18 16:46:23 +05:00
Bilal Qamar
2266486398 feat: bumped frontend-platform to v6 (#352) 2023-10-18 16:05:49 +05:00
renovate[bot]
91cd859ffc chore(deps): update dependency @edx/frontend-platform to v5.6.1 2023-10-16 12:39:08 +00:00
renovate[bot]
c5e8a12f89 chore(deps): update dependency @testing-library/jest-dom to v5.17.0 2023-10-16 11:17:40 +00:00
Muhammad Abdullah Waheed
edd4cc4589 feat: babel-plugin-react-intl to babel-plugin-formatjs migration (#346)
* feat: babel-plugin-react-intl to babel-plugin-formatjs migration

* fix: upgraded frontend-build to fix security issue
2023-10-11 17:36:54 +05:00
renovate[bot]
6202398292 chore(deps): update dependency @edx/frontend-platform to v5.5.2 2023-10-09 16:04:26 +00:00
renovate[bot]
f8c26fc369 chore(deps): update dependency @testing-library/react to v12.1.5 2023-10-09 09:21:48 +00:00
Mashal Malik
63656116c5 refactor: update README file (#341)
* refactor: update readMe file

* refactor: update readMe file

* refactor: replace npm install with npm ci
2023-10-04 12:26:27 +05:00
Kristin Aoki
e2ccd1b56a feat: add studio footer for studio mfes 2023-10-02 10:49:55 -04:00
KristinAoki
c0f4b90505 Merge branch 'master' into KristinAoki/add-studio-footer 2023-10-02 10:30:49 -04:00
Mashal Malik
c3f5a07256 refactor: add @openedx in renovate automate configuration (#342)
Co-authored-by: Muhammad Abdullah Waheed <42172960+abdullahwaheed@users.noreply.github.com>
2023-10-02 19:06:37 +05:00
renovate[bot]
7450b8f061 chore(deps): update dependency @edx/paragon to v21.3.1 2023-10-02 09:25:06 +00:00
renovate[bot]
677d72813e chore(deps): update dependency @edx/frontend-build to v12.9.17 2023-10-02 08:00:58 +00:00
KristinAoki
abe24fb46a fix: remove unnecessary test 2023-09-29 16:10:23 -07:00
KristinAoki
ce5396c9ab fix: remove unused message 2023-09-29 15:25:39 -07:00
KristinAoki
dc0982dfd2 fix: remove unused code 2023-09-29 15:20:37 -07:00
KristinAoki
a9f6ca8b77 feat: add studio footer 2023-09-29 15:14:53 -07:00
renovate[bot]
d2e790ce99 chore(deps): update dependency @edx/paragon to v21.2.0 2023-09-25 12:16:29 +00:00
renovate[bot]
f1bd7d2ec2 chore(deps): update dependency @edx/frontend-platform to v5.4.0 2023-09-25 10:41:58 +00:00
renovate[bot]
425616defe chore(deps): update dependency @edx/paragon to v21 (#335)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-09-25 11:30:07 +05:00
renovate[bot]
fca4a6bd29 chore(deps): update dependency semantic-release to v21.1.2 2023-09-18 12:03:06 +00:00
renovate[bot]
bdaaa8541f chore(deps): update dependency @edx/frontend-platform to v5.3.2 2023-09-18 11:17:44 +00:00
renovate[bot]
0fce9cd9f7 chore(deps): update dependency @edx/frontend-platform to v5.3.1 2023-09-07 12:42:41 +00:00
Mashal Malik
e4adba4f66 refactor: update lock file version (#331)
Co-authored-by: Muhammad Abdullah Waheed <42172960+abdullahwaheed@users.noreply.github.com>
2023-08-31 12:44:46 +05:00
renovate[bot]
be8529246c chore(deps): update dependency semantic-release to v21.1.1 2023-08-28 13:35:14 +00:00
renovate[bot]
98f818e295 chore(deps): update dependency @edx/paragon to v20.46.2 2023-08-28 10:02:44 +00:00
renovate[bot]
fb869bc008 chore(deps): update dependency @edx/frontend-platform to v5.1.0 2023-08-21 15:37:16 +00:00
renovate[bot]
879f384809 fix(deps): update font awesome to v6.4.2 2023-08-21 14:20:50 +00:00
renovate[bot]
b65a80616b chore(deps): update dependency semantic-release to v21.0.9 2023-08-21 10:34:05 +00:00
renovate[bot]
d5f0bca2b7 chore(deps): update dependency @edx/frontend-build to v12.9.10 2023-08-21 07:38:30 +00:00
Syed Ali Abbas Zaidi
3e6eaa1ded feat: upgrade react router to v6 (#275)
* feat: upgrade react router to v6

* chore: update peer deps
2023-08-16 16:48:10 +05:00
renovate[bot]
48b56df115 chore(deps): update dependency @edx/frontend-platform to v4.6.1 2023-08-14 13:25:28 +00:00
renovate[bot]
1d2bfd8e40 chore(deps): update dependency @edx/frontend-build to v12.9.4 2023-08-14 09:47:01 +00:00
renovate[bot]
197f24a684 chore(deps): update dependency @edx/frontend-build to v12.9.3 2023-07-31 07:48:35 +00:00
renovate[bot]
0d6c99acbc chore(deps): update dependency @edx/frontend-build to v12.9.2 2023-07-24 12:20:51 +00:00
renovate[bot]
8213c3a66a chore(deps): update dependency @edx/paragon to v20.45.5 2023-07-24 09:23:45 +00:00
renovate[bot]
a6ae384f7e chore(deps): update dependency @edx/frontend-build to v12.8.66 2023-07-17 09:34:35 +00:00
renovate[bot]
dd612879e2 chore(deps): update dependency @edx/paragon to v20.45.2 2023-07-17 06:06:51 +00:00
renovate[bot]
248bab9370 chore(deps): update dependency @edx/frontend-build to v12.8.65 (#318)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-17 10:05:15 +05:00
renovate[bot]
92c879bf8f chore(deps): update dependency @edx/paragon to v20.45.1 2023-07-14 17:20:12 +00:00
14 changed files with 7946 additions and 1207 deletions

View File

@@ -8,6 +8,11 @@ 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
TERMS_OF_SERVICE_URL=null
PRIVACY_POLICY_URL=null
SUPPORT_EMAIL=null
STUDIO_BASE_URL=http://localhost:18010
SHOW_ACCESSIBILITY_PAGE=false
ORDER_HISTORY_URL=localhost:1996/orders
REFRESH_ACCESS_TOKEN_ENDPOINT=http://localhost:18000/login_refresh
SEGMENT_KEY=null

View File

@@ -11,13 +11,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Nodejs Env
run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
- name: Setup Nodejs
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VER }}
- name: Install dependencies

View File

@@ -10,4 +10,4 @@ on:
jobs:
version-check:
uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master
uses: openedx/.github/.github/workflows/lockfile-check.yml@master

View File

@@ -9,13 +9,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Nodejs Env
run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VER }}
- name: Install dependencies

View File

@@ -6,7 +6,7 @@ i18n = ./src/i18n
transifex_input = $(i18n)/transifex_input.json
# This directory must match .babelrc .
transifex_temp = ./temp/babel-plugin-react-intl
transifex_temp = ./temp/babel-plugin-formatjs
build:
rm -rf ./dist
@@ -17,7 +17,7 @@ build:
@rm -rf dist/__mocks__
requirements:
npm install
npm ci
i18n.extract:
# Pulling display strings from .jsx files into .json files...

View File

@@ -5,14 +5,33 @@ frontend-component-footer
|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|
********
Overview
Purpose
********
A generic footer for Open edX micro-frontend applications. It includes a logo and an optional language selector dropdown.
************
***************
Getting Started
***************
Prerequisites
=============
The `devstack`_ is currently recommended as a development environment for your
new MFE. If you start it with ``make dev.up.lms`` that should give you
everything you need as a companion to this frontend.
Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer
to the `relevant tutor-mfe documentation`_ to get started using it.
.. _Devstack: https://github.com/openedx/devstack
.. _Tutor: https://github.com/overhangio/tutor
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development
Requirements
************
============
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/openedx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx>`_
@@ -24,9 +43,8 @@ This component requires that the following environment variable be set by the co
* ``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:
@@ -34,9 +52,33 @@ To install this footer into your Open edX micro-frontend, run the following comm
This will make the component available to be imported into your application.
*****
Cloning and Startup
===================
.. code-block::
1. Clone your new repo:
``git clone https://github.com/openedx/frontend-component-footer.git``
2. Use node v18.x.
The current version of the micro-frontend build scripts support node 18.
Using other major versions of node *may* work, but this is unsupported. For
convenience, this repository includes an .nvmrc file to help in setting the
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
3. Install npm dependencies:
``cd frontend-component-footer && npm ci``
4. Start the dev server:
``npm start``
Usage
*****
=====
This library has the following exports:
@@ -71,9 +113,8 @@ Component Usage Example::
* `An example of minimal component and messages usage. <https://github.com/openedx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx#L23>`_
* `An example of SCSS file usage. <https://github.com/openedx/frontend-template-application/blob/3cd5485bf387b8c479baf6b02bf59e3061dc3465/src/index.scss#L9>`_
***********
Development
***********
===========
Install dependencies::
@@ -87,6 +128,63 @@ Build a production distribution::
npm run build
License
=======
The code in this repository is licensed under the AGPLv3 unless otherwise
noted.
Please see `LICENSE <LICENSE>`_ for details.
Contributing
============
Contributions are very welcome. Please read `How To Contribute`_ for details.
.. _How To Contribute: https://openedx.org/r/how-to-contribute
This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features. However, please make sure
to have a discussion about your new feature idea with the maintainers prior to
beginning development to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.
Getting Help
===========
If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack workspace`_. Because this is a
frontend repository, the best place to discuss it would be in the `#wg-frontend
channel`_.
For anything non-trivial, the best path is to open an issue in this repository
with as many details about the issue you are facing as you can provide.
https://github.com/openedx/frontend-component-footer/issues
For more information about these options, see the `Getting Help`_ page.
.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
.. _Getting Help: https://openedx.org/community/connect
The Open edX Code of Conduct
============================
All community members are expected to follow the `Open edX Code of Conduct`_.
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
Reporting Security Issues
=========================
Please do not report security issues in public. Please email security@openedx.org.
.. |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

8653
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -8,7 +8,7 @@
},
"scripts": {
"build": "make build",
"i18n_extract": "BABEL_ENV=i18n fedx-scripts babel src --quiet > /dev/null",
"i18n_extract": "fedx-scripts formatjs extract",
"lint": "fedx-scripts eslint --ext .js --ext .jsx .",
"snapshot": "fedx-scripts jest --updateSnapshot",
"start": "fedx-scripts webpack-dev-server --progress",
@@ -33,12 +33,13 @@
},
"homepage": "https://github.com/openedx/frontend-component-footer#readme",
"devDependencies": {
"@edx/brand": "npm:@edx/brand-openedx@1.2.0",
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
"@edx/browserslist-config": "^1.1.1",
"@edx/frontend-build": "12.8.61",
"@edx/frontend-platform": "4.6.0",
"@edx/paragon": "^20.44.0",
"@edx/frontend-build": "13.0.8",
"@edx/frontend-platform": "6.1.1",
"@edx/reactifex": "^2.1.1",
"@testing-library/jest-dom": "^5.16.4",
"@testing-library/react": "^12.1.1",
"@wojtekmaj/enzyme-adapter-react-17": "0.8.0",
"enzyme": "3.11.0",
"husky": "8.0.3",
@@ -46,20 +47,22 @@
"react": "17.0.2",
"react-dom": "17.0.2",
"react-redux": "7.2.9",
"react-router-dom": "5.3.4",
"react-router-dom": "6.20.1",
"react-test-renderer": "17.0.2",
"redux": "4.2.1",
"semantic-release": "21.0.7"
"semantic-release": "21.1.2"
},
"dependencies": {
"@fortawesome/fontawesome-svg-core": "6.4.0",
"@fortawesome/free-brands-svg-icons": "6.4.0",
"@fortawesome/free-regular-svg-icons": "6.4.0",
"@fortawesome/free-solid-svg-icons": "6.4.0",
"@fortawesome/react-fontawesome": "0.2.0"
"@edx/paragon": "^21.3.1",
"@fortawesome/fontawesome-svg-core": "6.5.1",
"@fortawesome/free-brands-svg-icons": "6.5.1",
"@fortawesome/free-regular-svg-icons": "6.5.1",
"@fortawesome/free-solid-svg-icons": "6.5.1",
"@fortawesome/react-fontawesome": "0.2.0",
"lodash": "^4.17.21"
},
"peerDependencies": {
"@edx/frontend-platform": "^4.0.0",
"@edx/frontend-platform": "^4.0.0 || ^5.0.0 || ^6.0.0",
"prop-types": "^15.5.10",
"react": "^16.9.0 || ^17.0.0",
"react-dom": "^16.9.0 || ^17.0.0"

View File

@@ -24,7 +24,7 @@
"automerge": true
},
{
"matchPackagePatterns": ["@edx"],
"matchPackagePatterns": ["@edx", "@openedx"],
"matchUpdateTypes": ["minor", "patch"],
"automerge": true
}

View File

@@ -0,0 +1,146 @@
import React, { useContext, useState } from 'react';
import _ from 'lodash';
import { intlShape, injectIntl, FormattedMessage } from '@edx/frontend-platform/i18n';
import { ensureConfig } from '@edx/frontend-platform';
import { AppContext } from '@edx/frontend-platform/react';
import {
ActionRow,
Button,
Container,
Hyperlink,
Image,
TransitionReplace,
} from '@edx/paragon';
import { ExpandLess, ExpandMore, Help } from '@edx/paragon/icons';
import messages from './messages';
ensureConfig([
'LMS_BASE_URL',
'MARKETING_SITE_BASE_URL',
'TERMS_OF_SERVICE_URL',
'PRIVACY_POLICY_URL',
'SUPPORT_EMAIL',
'SITE_NAME',
'STUDIO_BASE_URL',
'SHOW_ACCESSIBILITY_PAGE',
], 'Studio Footer component');
const StudioFooter = ({
// injected
intl,
}) => {
const [isOpen, setIsOpen] = useState(false);
const { config } = useContext(AppContext);
return (
<>
<div className="m-0 mt-6 row align-items-center justify-content-center">
<div className="col border-top mr-2" />
<Button
data-testid="helpToggleButton"
variant="outline-primary"
onClick={() => setIsOpen(!isOpen)}
iconBefore={Help}
iconAfter={isOpen ? ExpandLess : ExpandMore}
size="sm"
>
{isOpen ? intl.formatMessage(messages.closeHelpButtonLabel)
: intl.formatMessage(messages.openHelpButtonLabel)}
</Button>
<div className="col border-top ml-2" />
</div>
<Container size="xl" className="px-4">
<TransitionReplace>
{isOpen ? (
<ActionRow key="help-link-button-row" className="py-4" data-testid="helpButtonRow">
<ActionRow.Spacer />
<Button as="a" href="https://docs.edx.org/" size="sm">
<FormattedMessage {...messages.edxDocumentationButtonLabel} />
</Button>
<Button
as="a"
href="https://open.edx.org/"
size="sm"
data-testid="openEdXPortalButton"
>
<FormattedMessage {...messages.openEdxPortalButtonLabel} />
</Button>
<Button
as="a"
href="https://www.edx.org/course/edx101-overview-of-creating-an-edx-course#.VO4eaLPF-n1"
size="sm"
>
<FormattedMessage {...messages.edx101ButtonLabel} />
</Button>
<Button
as="a"
href="https://www.edx.org/course/studiox-creating-a-course-with-edx-studio"
size="sm"
>
<FormattedMessage {...messages.studioXButtonLabel} />
</Button>
{!_.isEmpty(config.SUPPORT_EMAIL) && (
<Button
as="a"
href={`mailto:${config.SUPPORT_EMAIL}`}
size="sm"
data-testid="contactUsButton"
>
<FormattedMessage {...messages.contactUsButtonLabel} />
</Button>
)}
<ActionRow.Spacer />
</ActionRow>
) : null}
</TransitionReplace>
<ActionRow className="pt-3 m-0 x-small">
© {new Date().getFullYear()} <Hyperlink destination={config.MARKETING_BASE_URL} target="_blank" className="ml-2">{config.SITE_NAME}</Hyperlink>
<ActionRow.Spacer />
{!_.isEmpty(config.TERMS_OF_SERVICE_URL) && (
<Hyperlink destination={config.TERMS_OF_SERVICE_URL} data-testid="termsOfService">
{intl.formatMessage(messages.termsOfServiceLinkLabel)}
</Hyperlink>
)}{!_.isEmpty(config.PRIVACY_POLICY_URL) && (
<Hyperlink destination={config.PRIVACY_POLICY_URL} data-testid="privacyPolicy">
{intl.formatMessage(messages.privacyPolicyLinkLabel)}
</Hyperlink>
)}
{config.SHOW_ACCESSIBILITY_PAGE === 'true' && (
<Hyperlink
destination={`${config.STUDIO_BASE_URL}/accessibility`}
data-testid="accessibilityRequest"
>
{intl.formatMessage(messages.accessibilityRequestLinkLabel)}
</Hyperlink>
)}
<Hyperlink destination={config.LMS_BASE_URL}>LMS</Hyperlink>
</ActionRow>
<ActionRow className="mt-3 pb-4 x-small">
{/*
Site operators: Please do not remove this paragraph! this attributes back to edX and
makes your acknowledgement of edX's trademarks clear.
Translators: 'edX' and 'Open edX' are trademarks of 'edX Inc.'. Please do not translate
any of these trademarks and company names.
*/}
<FormattedMessage {...messages.trademarkMessage} />
<Hyperlink className="ml-1" destination="https://www.edx.org">edX Inc</Hyperlink>.
<ActionRow.Spacer />
<Hyperlink destination="https://open.edx.org" className="float-right">
<Image
width="120px"
alt="Powered by Open edX"
src="https://logos.openedx.org/open-edx-logo-tag.png"
/>
</Hyperlink>
</ActionRow>
</Container>
</>
);
};
StudioFooter.propTypes = {
// injected
intl: intlShape.isRequired,
};
export default injectIntl(StudioFooter);

View File

@@ -0,0 +1,121 @@
/* eslint-disable react/prop-types */
import React, { useMemo } from 'react';
import { fireEvent, render, screen } from '@testing-library/react';
import '@testing-library/jest-dom/extend-expect';
import { IntlProvider } from '@edx/frontend-platform/i18n';
import { AppContext } from '@edx/frontend-platform/react';
import StudioFooter from './StudioFooter';
import messages from './messages';
const config = {
LMS_BASE_URL: process.env.LMS_BASE_URL,
MARKETING_SITE_BASE_URL: process.env.MARKETING_SITE_BASE_URL,
TERMS_OF_SERVICE_URL: process.env.TERMS_OF_SERVICE_URL,
PRIVACY_POLICY_URL: process.env.PRIVACY_POLICY_URL,
SUPPORT_EMAIL: process.env.SUPPORT_EMAIL,
SITE_NAME: process.env.SITE_NAME,
STUDIO_BASE_URL: process.env.STUDIO_BASE_URL,
SHOW_ACCESSIBILITY_PAGE: process.env.SHOW_ACCESSIBILITY_PAGE,
};
let currentConfig = config;
const Component = ({ updateVariable }) => {
if (updateVariable) {
const [variable, value] = updateVariable;
currentConfig = {
...config,
[variable]: value,
};
}
const contextValue = useMemo(() => ({
authenticatedUser: null,
config: currentConfig,
}), []);
return (
<IntlProvider locale="en">
<AppContext.Provider value={contextValue}>
<StudioFooter />
</AppContext.Provider>
</IntlProvider>
);
};
jest.unmock('@edx/paragon');
describe('Footer', () => {
describe('help section default view', () => {
it('help button should read Looking for help with Studio?', () => {
render(<Component />);
expect(screen.getByText(messages.openHelpButtonLabel.defaultMessage))
.toBeVisible();
});
it('help button link row should not be visible', () => {
render(<Component />);
expect(screen.queryByTestId('helpButtonRow')).toBeNull();
});
});
describe('help section expanded view', () => {
it('help button should read Hide Studio help', () => {
render(<Component />);
const helpToggleButton = screen.getByText(messages.openHelpButtonLabel.defaultMessage);
fireEvent.click(helpToggleButton);
expect(screen.getByText(messages.closeHelpButtonLabel.defaultMessage))
.toBeVisible();
});
it('help button link row should be visible', () => {
render(<Component />);
const helpToggleButton = screen.getByText(messages.openHelpButtonLabel.defaultMessage);
fireEvent.click(helpToggleButton);
expect(screen.getByTestId('helpButtonRow')).toBeVisible();
});
it('Open edX portal button should be visible', () => {
render(<Component />);
const helpToggleButton = screen.getByText(messages.openHelpButtonLabel.defaultMessage);
fireEvent.click(helpToggleButton);
expect(screen.getByTestId('openEdXPortalButton')).toBeVisible();
});
it('should not show contact us button', () => {
render(<Component />);
const helpToggleButton = screen.getByText(messages.openHelpButtonLabel.defaultMessage);
fireEvent.click(helpToggleButton);
expect(screen.queryByTestId('contactUsButton')).toBeNull();
});
it('should show contact us button', () => {
render(<Component updateVariable={['SUPPORT_EMAIL', 'support@email.com']} />);
const helpToggleButton = screen.getByText(messages.openHelpButtonLabel.defaultMessage);
fireEvent.click(helpToggleButton);
expect(screen.getByTestId('contactUsButton')).toBeVisible();
});
});
describe('policy link row', () => {
it('should only show LMS link', () => {
render(<Component />);
expect(screen.getByText('LMS')).toBeVisible();
expect(screen.queryByTestId('termsOfService')).toBeNull();
expect(screen.queryByTestId('privacyPolicy')).toBeNull();
expect(screen.queryByTestId('accessibilityRequest')).toBeNull();
});
it('should show terms of service link', () => {
render(<Component updateVariable={['TERMS_OF_SERVICE_URL', 'termsofserviceurl']} />);
expect(screen.getByText('LMS')).toBeVisible();
expect(screen.queryByTestId('termsOfService')).toBeVisible();
expect(screen.queryByTestId('privacyPolicy')).toBeNull();
expect(screen.queryByTestId('accessibilityRequest')).toBeNull();
});
it('should show privacy policy link', () => {
render(<Component updateVariable={['PRIVACY_POLICY_URL', 'privacypolicyurl']} />);
expect(screen.getByText('LMS')).toBeVisible();
expect(screen.queryByTestId('termsOfService')).toBeNull();
expect(screen.queryByTestId('privacyPolicy')).toBeVisible();
expect(screen.queryByTestId('accessibilityRequest')).toBeNull();
});
it('should show accessibilty request link', () => {
render(<Component updateVariable={['SHOW_ACCESSIBILITY_PAGE', 'true']} />);
expect(screen.getByText('LMS')).toBeVisible();
expect(screen.queryByTestId('termsOfService')).toBeNull();
expect(screen.queryByTestId('privacyPolicy')).toBeNull();
expect(screen.queryByTestId('accessibilityRequest')).toBeVisible();
});
});
});

View File

@@ -0,0 +1,3 @@
import StudioFooter from './StudioFooter';
export default StudioFooter;

View File

@@ -0,0 +1,61 @@
import { defineMessages } from '@edx/frontend-platform/i18n';
const messages = defineMessages({
openHelpButtonLabel: {
id: 'authoring.footer.help.openHelp.button.label',
defaultMessage: 'Looking for help with Studio?',
description: 'Label for button that opens the collapsed section with help buttons',
},
closeHelpButtonLabel: {
id: 'authoring.footer.help.closeHelp.button.label',
defaultMessage: 'Hide Studio help',
description: 'Label for button that closes the collapsed section with help buttons',
},
edxDocumentationButtonLabel: {
id: 'authoring.footer.help.edxDocumentation.button.label',
defaultMessage: 'edX documentation',
description: 'Label for button that links to the edX documentation site',
},
openEdxPortalButtonLabel: {
id: 'authoring.footer.help.openEdxPortal.button.label',
defaultMessage: 'Open edX portal',
description: 'Label for button that links to the Open edX portal',
},
edx101ButtonLabel: {
id: 'authoring.footer.help.edx101.button.label',
defaultMessage: 'Enroll in edX 101',
description: 'Label for button that links to the edX 101 course',
},
studioXButtonLabel: {
id: 'authoring.footer.help.studioX.button.label',
defaultMessage: 'Enroll in StudioX',
description: 'Label for button that links to the edX StudioX course',
},
contactUsButtonLabel: {
id: 'authoring.footer.help.contactUs.button.label',
defaultMessage: 'Contact us',
description: 'Label for button that links to the email for partner support',
},
termsOfServiceLinkLabel: {
id: 'authoring.footer.termsOfService.link.label',
defaultMessage: 'Terms of Service',
description: 'Label for button that links to the terms of service page',
},
privacyPolicyLinkLabel: {
id: 'authoring.footer.privacyPolicy.link.label',
defaultMessage: 'Privacy Policy',
description: 'Label for button that links to the privacy policy page',
},
accessibilityRequestLinkLabel: {
id: 'authoring.footer.accessibilityRequest.link.label',
defaultMessage: 'Accessibility Accomodation Request',
description: 'Label for button that links to the accessibility accomodation requests page',
},
trademarkMessage: {
id: 'authoring.footer.trademark.message',
defaultMessage: 'edX and Open edX, and the edX and Open edX logos are registered trademarks of',
description: 'Message about the use of logos and names edX and Open edX',
},
});
export default messages;

View File

@@ -1,5 +1,6 @@
import Footer, { EVENT_NAMES } from './components/Footer';
import messages from './i18n/index';
import StudioFooter from './components/studio-footer';
export default Footer;
export { messages, EVENT_NAMES };
export { messages, EVENT_NAMES, StudioFooter };