feat: expose containerProps in StudioFooter [FC-0062] (#463 )

chore(deps): update dependency @openedx/frontend-build to v14.1.5
chore(deps): update dependency @openedx/frontend-build to v14.1.4
2024-10-01 09:44:49 -04:00 · 2024-09-30 04:09:28 +00:00 · 2024-09-23 04:33:25 +00:00 · 2024-09-19 17:50:12 -04:00 · 2024-09-16 11:41:53 -04:00 · 2024-09-16 11:27:58 +00:00
28 changed files with 6981 additions and 14600 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -9,17 +9,18 @@ on:
 jobs:
  tests:
    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [18, 20]
    steps:
    - name: Checkout
      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@v4
      with:
-        node-version: ${{ env.NODE_VER }}
+        node-version: ${{ matrix.node }}
    - name: Install dependencies
      run: npm ci
    - name: Validate package-lock.json changes
@@ -33,4 +34,7 @@ jobs:
    - name: i18n_extract
      run: npm run i18n_extract
    - name: Coverage
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: true
--- a/.github/workflows/lockfileversion-check.yml
+++ b/.github/workflows/lockfileversion-check.yml
@@ -10,4 +10,4 @@ on:

 jobs:
  version-check:
-    uses: openedx/.github/.github/workflows/lockfile-check.yml@master
+    uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -30,7 +30,10 @@ jobs:
    - name: i18n_extract
      run: npm run i18n_extract
    - name: Coverage
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        fail_ci_if_error: false
    - name: Build
      run: npm run build
    - name: Release
--- a/.gitignore
+++ b/.gitignore
@@ -10,3 +10,4 @@ src/i18n/transifex_input.json
 temp/babel-plugin-react-intl
 /.vscode
 module.config.js
+src/i18n/messages
--- a/.nvmrc
+++ b/.nvmrc
@@ -1 +1 @@
-18
+20
--- a/.tx/config
+++ b/.tx/config
@@ -1,9 +0,0 @@
-[main]
-host = https://www.transifex.com
-
-[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
-
--- a/17
+++ b/17
@@ -1,6 +1,3 @@
-export TRANSIFEX_RESOURCE = frontend-component-footer
-transifex_langs = "ar,fr,es_419,zh_CN,pt,it,de,uk,ru,hi,fr_CA,it_IT,pt_PT,de_DE"
-
 transifex_utils = ./node_modules/.bin/transifex-utils.js
 i18n = ./src/i18n
 transifex_input = $(i18n)/transifex_input.json
@@ -35,20 +32,6 @@ detect_changed_source_translations:
 	# Checking for changed translations...
 	git diff --exit-code $(i18n)

-# Pushes translations to Transifex.  You must run make extract_translations first.
-push_translations:
-	# Pushing strings to Transifex...
-	tx push -s
-	# Fetching hashes from Transifex...
-	./node_modules/@edx/reactifex/bash_scripts/get_hashed_strings_v3.sh
-	# Writing out comments to file...
-	$(transifex_utils) $(transifex_temp) --comments --v3-scripts-path
-	# Pushing comments to Transifex...
-	./node_modules/@edx/reactifex/bash_scripts/put_comments_v3.sh
-
-# Pulls translations from Transifex.
-pull_translations:
-	tx pull -t -f --mode reviewed --languages=$(transifex_langs)

 # This target is used by Travis.
 validate-no-uncommitted-package-lock-changes:
--- a/README.rst
+++ b/README.rst
@@ -93,6 +93,12 @@ This library has the following exports:
  language from its dropdown.
 * supportedLanguages: An array of objects representing available languages.  See example below for object shape.

+Plugin
+======
+The footer can be replaced using using `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_.
+
+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
 ========

@@ -113,6 +119,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
 ===========

--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -13,7 +13,7 @@
    "snapshot": "fedx-scripts jest --updateSnapshot",
    "start": "fedx-scripts webpack-dev-server --progress",
    "start:with-theme": "paragon install-theme && npm start && npm install",
-    "test": "fedx-scripts jest"
+    "test": "fedx-scripts jest --coverage"
  },
  "files": [
    "/dist"
@@ -36,10 +36,11 @@
  "devDependencies": {
    "@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
    "@edx/browserslist-config": "^1.1.1",
-    "@openedx/frontend-build": "^13.0.19",
-    "@openedx/paragon": "22.0.0",
-    "@edx/frontend-platform": "6.2.0",
+    "@edx/frontend-platform": "8.1.1",
    "@edx/reactifex": "^2.1.1",
+    "@openedx/frontend-build": "14.1.5",
+    "@openedx/frontend-plugin-framework": "^1.1.2",
+    "@openedx/paragon": "^22.8.1",
    "@testing-library/jest-dom": "^5.16.4",
    "@testing-library/react": "^12.1.1",
    "husky": "8.0.3",
@@ -47,21 +48,24 @@
    "react": "17.0.2",
    "react-dom": "17.0.2",
    "react-redux": "7.2.9",
-    "react-router-dom": "6.21.3",
+    "react-router-dom": "6.26.2",
    "react-test-renderer": "17.0.2",
    "redux": "4.2.1",
    "semantic-release": "21.1.2"
  },
  "dependencies": {
-    "@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"
+    "@fortawesome/fontawesome-svg-core": "6.6.0",
+    "@fortawesome/free-brands-svg-icons": "6.6.0",
+    "@fortawesome/free-regular-svg-icons": "6.6.0",
+    "@fortawesome/free-solid-svg-icons": "6.6.0",
+    "@fortawesome/react-fontawesome": "0.2.2",
+    "classnames": "^2.5.1",
+    "jest-environment-jsdom": "^29.7.0",
+    "lodash": "^4.17.21",
+    "ts-jest": "^29.1.2"
  },
  "peerDependencies": {
-    "@edx/frontend-platform": "^7.0.0",
+    "@edx/frontend-platform": "^7.0.0 || ^8.0.0",
    "@openedx/paragon": ">= 21.11.3 < 23.0.0",
    "prop-types": "^15.5.10",
    "react": "^16.9.0 || ^17.0.0",
--- a/src/components/snapshots/Footer.test.jsx.snap
+++ b/src/components/snapshots/Footer.test.jsx.snap
@@ -17,7 +17,7 @@ exports[`<Footer /> renders correctly renders with a language selector 1`] = `
        alt="Powered by Open edX"
        src="https://edx-cdn.org/v3/default/logo-trademark.svg"
        style={
-          Object {
+          {
            "maxHeight": 45,
          }
        }
@@ -86,7 +86,7 @@ exports[`<Footer /> renders correctly renders without a language selector 1`] =
        alt="Powered by Open edX"
        src="https://edx-cdn.org/v3/default/logo-trademark.svg"
        style={
-          Object {
+          {
            "maxHeight": 45,
          }
        }
@@ -116,7 +116,7 @@ exports[`<Footer /> renders correctly renders without a language selector in es
        alt="Powered by Open edX"
        src="https://edx-cdn.org/v3/default/logo-trademark.svg"
        style={
-          Object {
+          {
            "maxHeight": 45,
          }
        }
--- a/src/components/studio-footer/StudioFooter.jsx
+++ b/src/components/studio-footer/StudioFooter.jsx
@@ -1,6 +1,6 @@
 import React, { useContext, useState } from 'react';
 import _ from 'lodash';
-import { intlShape, injectIntl, FormattedMessage } from '@edx/frontend-platform/i18n';
+import { useIntl, FormattedMessage } from '@edx/frontend-platform/i18n';
 import { ensureConfig } from '@edx/frontend-platform';
 import { AppContext } from '@edx/frontend-platform/react';
 import {
@@ -12,6 +12,9 @@ import {
  TransitionReplace,
 } from '@openedx/paragon';
 import { ExpandLess, ExpandMore, Help } from '@openedx/paragon/icons';
+import classNames from 'classnames';
+import PropTypes from 'prop-types';
+
 import messages from './messages';

 ensureConfig([
@@ -26,12 +29,14 @@ ensureConfig([
 ], 'Studio Footer component');

 const StudioFooter = ({
-  // injected
-  intl,
+  containerProps,
 }) => {
+  const intl = useIntl();
  const [isOpen, setIsOpen] = useState(false);
  const { config } = useContext(AppContext);

+  const { containerClassName, ...restContainerProps } = containerProps || {};
+
  return (
    <>
      <div className="m-0 mt-6 row align-items-center justify-content-center">
@@ -49,7 +54,11 @@ const StudioFooter = ({
        </Button>
        <div className="col border-top ml-2" />
      </div>
-      <Container size="xl" className="px-4">
+      <Container
+        size="xl"
+        className={classNames('px-4', containerClassName)}
+        {...restContainerProps}
+      >
        <TransitionReplace>
          {isOpen ? (
            <ActionRow key="help-link-button-row" className="py-4" data-testid="helpButtonRow">
@@ -139,8 +148,11 @@ const StudioFooter = ({
 };

 StudioFooter.propTypes = {
-  // injected
-  intl: intlShape.isRequired,
+  containerProps: PropTypes.shape(Container.propTypes),
 };

-export default injectIntl(StudioFooter);
+StudioFooter.defaultProps = {
+  containerProps: {},
+};
+
+export default StudioFooter;
--- a/src/i18n/index.js
+++ b/src/i18n/index.js
@@ -1,34 +1 @@
-import arMessages from './messages/ar.json';
-import frMessages from './messages/fr.json';
-import es419Messages from './messages/es_419.json';
-import zhcnMessages from './messages/zh_CN.json';
-import ptMessages from './messages/pt.json';
-import itMessages from './messages/it.json';
-import ukMessages from './messages/uk.json';
-import deMessages from './messages/de.json';
-import ruMessages from './messages/ru.json';
-import hiMessages from './messages/hi.json';
-import frCAMessages from './messages/fr_CA.json';
-import dedeCAMessages from './messages/de_DE.json';
-import ititCAMessages from './messages/it_IT.json';
-import ptptCAMessages from './messages/pt_PT.json';
-// no need to import en messages-- they are in the defaultMessage field
-
-const messages = {
-  ar: arMessages,
-  'es-419': es419Messages,
-  fr: frMessages,
-  'zh-cn': zhcnMessages,
-  pt: ptMessages,
-  it: itMessages,
-  de: deMessages,
-  hi: hiMessages,
-  'fr-ca': frCAMessages,
-  ru: ruMessages,
-  uk: ukMessages,
-  'de-de': dedeCAMessages,
-  'it-it': ititCAMessages,
-  'pt-pt': ptptCAMessages,
-};
-
-export default messages;
+export default {};
--- a/src/i18n/messages/ar.json
+++ b/src/i18n/messages/ar.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/de.json
+++ b/src/i18n/messages/de.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/de_DE.json
+++ b/src/i18n/messages/de_DE.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/es_419.json
+++ b/src/i18n/messages/es_419.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/fr.json
+++ b/src/i18n/messages/fr.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/fr_CA.json
+++ b/src/i18n/messages/fr_CA.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/hi.json
+++ b/src/i18n/messages/hi.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/it.json
+++ b/src/i18n/messages/it.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/it_IT.json
+++ b/src/i18n/messages/it_IT.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/pt.json
+++ b/src/i18n/messages/pt.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/pt_PT.json
+++ b/src/i18n/messages/pt_PT.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/ru.json
+++ b/src/i18n/messages/ru.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/uk.json
+++ b/src/i18n/messages/uk.json
@@ -1 +0,0 @@
-{}
--- a/src/i18n/messages/zh_CN.json
+++ b/src/i18n/messages/zh_CN.json
@@ -1 +0,0 @@
-{}
--- a/src/index.js
+++ b/src/index.js
@@ -3,4 +3,6 @@ import messages from './i18n/index';
 import StudioFooter from './components/studio-footer';

 export default Footer;
-export { messages, EVENT_NAMES, StudioFooter };
+export {
+  messages, EVENT_NAMES, StudioFooter,
+};
Author	SHA1	Message	Date
Rômulo Penido	cc647e7bc8	feat: expose containerProps in StudioFooter [FC-0062] (#463 )	2024-10-01 09:44:49 -04:00
renovate[bot]	2d5f5fe787	chore(deps): update dependency @openedx/frontend-build to v14.1.5	2024-09-30 04:09:28 +00:00
renovate[bot]	ef7bd9284a	chore(deps): update dependency @openedx/frontend-build to v14.1.4	2024-09-23 04:33:25 +00:00
Bilal Qamar	10f9d7c1cd	build: Upgrade to Node 20 (#471 )	2024-09-19 17:50:12 -04:00
Bilal Qamar	6b3a49ccec	test: Add Node 20 to CI matrix (#467 )	2024-09-16 11:41:53 -04:00
renovate[bot]	f473c98bb8	chore(deps): update dependency @openedx/paragon to v22.8.1	2024-09-16 11:27:58 +00:00
renovate[bot]	bd52be3177	chore(deps): update dependency react-router-dom to v6.26.2	2024-09-16 07:18:57 +00:00
renovate[bot]	ef12ac20fe	chore(deps): update dependency @openedx/frontend-plugin-framework to v1.3.0	2024-09-09 07:44:24 +00:00
renovate[bot]	7fa6bd8740	chore(deps): update dependency @openedx/frontend-build to v14.1.2	2024-09-09 05:03:32 +00:00
renovate[bot]	8d9178f532	chore(deps): update dependency @openedx/frontend-build to v14.1.1	2024-09-02 07:37:30 +00:00
renovate[bot]	98bcacfced	fix(deps): update font awesome to v6.6.0	2024-08-26 11:26:33 +00:00
renovate[bot]	ac78454133	fix(deps): update dependency ts-jest to v29.2.5	2024-08-26 07:03:36 +00:00
renovate[bot]	09b7c8be9a	chore(deps): update dependency @openedx/frontend-build to v14.1.0	2024-08-19 10:06:43 +00:00
renovate[bot]	c992a9129a	chore(deps): update dependency react-router-dom to v6.26.1	2024-08-19 07:52:04 +00:00
renovate[bot]	7f6ad73a25	chore(deps): update dependency @openedx/frontend-build to v14.0.15	2024-08-12 12:21:16 +00:00
renovate[bot]	cefbd28d9b	chore(deps): update dependency @openedx/frontend-plugin-framework to v1.2.3	2024-08-12 06:52:01 +00:00
renovate[bot]	c26bdc54e1	chore(deps): update dependency react-router-dom to v6.26.0	2024-08-05 09:38:33 +00:00
renovate[bot]	02f6b44368	fix(deps): update dependency ts-jest to v29.2.4	2024-08-05 06:46:35 +00:00
renovate[bot]	4cbde7e38f	chore(deps): update dependency @openedx/frontend-build to v14.0.14	2024-07-29 10:54:37 +00:00
renovate[bot]	bdb6ecb79f	chore(deps): update dependency @edx/frontend-platform to v8.1.1	2024-07-29 07:14:47 +00:00
renovate[bot]	46c1ffd731	chore(deps): update dependency react-router-dom to v6.25.1	2024-07-22 10:14:39 +00:00
renovate[bot]	b6bd211c6e	chore(deps): update dependency @openedx/paragon to v22.7.0	2024-07-22 06:29:45 +00:00
renovate[bot]	ef8445a1b2	fix(deps): update dependency ts-jest to v29.2.3	2024-07-22 04:08:27 +00:00
renovate[bot]	5b34595520	fix(deps): update dependency ts-jest to v29.2.2	2024-07-15 09:54:25 +00:00
renovate[bot]	32ae2d8e7c	chore(deps): update dependency @edx/frontend-platform to v8.1.0	2024-07-15 06:51:47 +00:00
renovate[bot]	abac1cd6d4	chore(deps): update dependency react-router-dom to v6.24.1	2024-07-08 08:29:05 +00:00
renovate[bot]	e0115e3d88	chore(deps): update dependency @openedx/frontend-plugin-framework to v1.2.2	2024-07-08 04:03:54 +00:00
renovate[bot]	ff18f3add9	fix(deps): update dependency ts-jest to v29.1.5	2024-07-01 12:24:59 +00:00
renovate[bot]	4926c3105b	chore(deps): update dependency react-router-dom to v6.24.0	2024-07-01 06:05:04 +00:00
renovate[bot]	838a81a020	chore(deps): update dependency @openedx/paragon to v22.6.1	2024-07-01 04:23:27 +00:00
Adolfo R. Brandes	0ac6840cea	Merge pull request #437 from arbrandes/update-codecov build: Update codecov and use token	2024-06-27 09:23:31 -03:00
Adolfo R. Brandes	26a17bf2e4	build: Update codecov and use token Update codecov to the latest version and start using the org-wide token for uploads. See https://github.com/openedx/wg-frontend/issues/179	2024-06-27 09:21:08 -03:00
renovate[bot]	17b9710810	chore(deps): update dependency @openedx/frontend-build to v14.0.10	2024-06-24 07:49:38 +00:00
renovate[bot]	df0129485e	chore(deps): update dependency @openedx/frontend-build to v14.0.9	2024-06-17 07:25:48 +00:00
renovate[bot]	1c2f290faa	chore(deps): update dependency @openedx/paragon to v22.6.0	2024-06-10 04:43:05 +00:00
renovate[bot]	9af9024bcc	chore(deps): update dependency @openedx/frontend-plugin-framework to v1.2.1	2024-06-03 09:31:52 +00:00
renovate[bot]	0008bd485a	chore(deps): update dependency @edx/frontend-platform to v8.0.4	2024-06-03 07:09:11 +00:00
renovate[bot]	181b9916a0	fix(deps): update dependency ts-jest to v29.1.4	2024-06-03 04:51:17 +00:00
renovate[bot]	22dbec317c	fix(deps): update dependency ts-jest to v29.1.3	2024-05-27 11:12:12 +00:00
renovate[bot]	6f15e4dafa	fix(deps): update dependency @fortawesome/react-fontawesome to v0.2.2	2024-05-27 07:24:23 +00:00
renovate[bot]	9f5aed3c76	fix(deps): update dependency @fortawesome/react-fontawesome to v0.2.1	2024-05-20 13:16:53 +00:00
renovate[bot]	54bc04b182	chore(deps): update dependency @edx/frontend-platform to v8.0.3	2024-05-20 04:41:57 +00:00
Brian Smith	ea2578fa15	fix!: remove `FooterSlot` component BREAKING CHANGE: the `FooterSlot` component will now be provided by `frontend-slot-footer`.	2024-05-14 11:31:03 -03:00
renovate[bot]	5f7fab236d	chore(deps): update dependency @openedx/paragon to v22.4.0	2024-05-13 09:24:28 +00:00
renovate[bot]	adf5f6c9a8	chore(deps): update dependency react-router-dom to v6.23.1	2024-05-13 06:20:49 +00:00
renovate[bot]	132b080195	chore(deps): update dependency @edx/frontend-platform to v8.0.2	2024-05-13 04:57:36 +00:00
Brian Smith	0d4ea96874	feat: provide `FooterSlot` This allows consuming MFEs to utilize a standardized Frontend Plugin Framework `PluginSlot` for replacing the footer.	2024-05-09 13:44:51 -03:00
renovate[bot]	8b9f5fa348	chore(deps): update dependency @openedx/paragon to v22.3.2	2024-05-06 06:47:39 +00:00
renovate[bot]	c014e30ca8	chore(deps): update dependency react-router-dom to v6.23.0	2024-04-29 09:52:14 +00:00
renovate[bot]	0e6ab3c358	chore(deps): update dependency @openedx/paragon to v22.3.1	2024-04-29 06:25:16 +00:00
renovate[bot]	7d0a126580	chore(deps): update dependency @edx/frontend-platform to v8.0.1	2024-04-29 04:40:18 +00:00
Bilal Qamar	c422ce40be	feat: Updated frontend-build to bump jest version to v29 (#317 ) * refactor: updated frontend-build to bump jest version to v29 * refactor: updated snapshots * refactor: updated frontend-build & failing snapshots * refactor: updated package-lock * refactor: updated frontend-build to alpha, updated snapshots * refactor: added overrides to resolve dependency issues * refactor: updated frontend-build to the version which has eslint alpha synced with master * feat: updated frontend-build and frontend-platform major versions * refactor: updated peerDependency as per suggestion	2024-04-23 13:56:59 +05:00
renovate[bot]	7299d5367f	chore(deps): update dependency @openedx/paragon to v22.2.2	2024-04-22 10:02:00 +00:00
renovate[bot]	38203b91ba	chore(deps): update dependency @edx/frontend-platform to v7.1.4	2024-04-22 06:32:01 +00:00
renovate[bot]	83c340fe08	chore(deps): update dependency @openedx/paragon to v22.2.1	2024-04-15 13:02:17 +00:00
renovate[bot]	9eaebf4b11	chore(deps): update dependency @openedx/frontend-build to v13.1.4	2024-04-15 09:58:34 +00:00
renovate[bot]	2a883857cf	chore(deps): update dependency @edx/brand to v1.2.3	2024-04-15 06:41:52 +00:00
renovate[bot]	5f26c1ae93	fix(deps): update font awesome to v6.5.2	2024-04-15 05:16:19 +00:00
Samir Sabri	89ad7234ac	feat!: remove Transifex calls for OEP-58 (#355 )	2024-03-25 11:23:10 -04:00
renovate[bot]	936915f81f	chore(deps): update dependency @edx/frontend-platform to v7.1.3	2024-03-25 12:10:00 +00:00
Bilal Qamar	b993992987	chore(deps): update frontend-platform to v7 (#409 )	2024-03-22 11:34:48 +05:00