{"_id":"@artistanbul/frontend-component-footer-bilisim","_rev":"1-77989af396f78fb68f070c0a182e1601","name":"@artistanbul/frontend-component-footer-bilisim","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.0":{"name":"@artistanbul/frontend-component-footer-bilisim","version":"1.1.0","author":{"name":"edX"},"license":"AGPL-3.0","_id":"@artistanbul/frontend-component-footer-bilisim@1.1.0","maintainers":[{"name":"artistanbul","email":"developers@artistanbul.io"}],"homepage":"https://github.com/openedx/frontend-component-footer#readme","bugs":{"url":"https://github.com/openedx/frontend-component-footer/issues"},"dist":{"shasum":"dd1e82a2bcc44828c750b356416eb59eb97f8f0d","tarball":"https://registry.npmjs.org/@artistanbul/frontend-component-footer-bilisim/-/frontend-component-footer-bilisim-1.1.0.tgz","fileCount":22,"integrity":"sha512-5mZCmCFNTr7LMrHNKC9kccfwy2GtfolcoMGMnyWgFTXIA2V90ZIioKMVino9x4Hv6ihwxNLNmhb85FAMJfj7Dw==","signatures":[{"sig":"MEQCIEcGPt9p2trjeCox17Tll7cSwi0gRXMkNT2lrbhBAsK3AiAFjdeQHZRO5sldut1s1QUU7H5QCCJpyY0UV4ckmYIsCw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":113535},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"npm run lint"}},"gitHead":"91ac43dd8759597b3139e83dc2dcd87c463c6221","scripts":{"lint":"fedx-scripts eslint --ext .js --ext .jsx .","test":"fedx-scripts jest --coverage","build":"make build","start":"fedx-scripts webpack-dev-server --progress","snapshot":"fedx-scripts jest --updateSnapshot","i18n_extract":"fedx-scripts formatjs extract","start:with-theme":"paragon install-theme && npm start && npm install"},"_npmUser":{"name":"artistanbul","email":"developers@artistanbul.io"},"repository":{"url":"git+https://github.com/openedx/frontend-component-footer.git","type":"git"},"_npmVersion":"8.19.3","description":"Footer component for use when building Open edX frontend applications","directories":{},"_nodeVersion":"16.19.0","dependencies":{"lodash":"^4.17.21","ts-jest":"^29.1.2","classnames":"^2.5.1","jest-environment-jsdom":"^29.7.0","@fortawesome/react-fontawesome":"0.2.2","@fortawesome/fontawesome-svg-core":"6.6.0","@fortawesome/free-solid-svg-icons":"6.6.0","@fortawesome/free-brands-svg-icons":"6.6.0","@fortawesome/free-regular-svg-icons":"6.6.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"husky":"8.0.3","react":"17.0.2","redux":"4.2.1","react-dom":"17.0.2","@edx/brand":"npm:@openedx/brand-openedx@^1.2.2","prop-types":"15.8.1","react-redux":"7.2.9","@edx/reactifex":"^2.1.1","@openedx/paragon":"^22.8.1","react-router-dom":"6.27.0","semantic-release":"21.1.2","react-test-renderer":"17.0.2","@edx/frontend-platform":"8.1.2","@testing-library/react":"^12.1.1","@openedx/frontend-build":"14.1.5","@edx/browserslist-config":"^1.1.1","@testing-library/jest-dom":"^5.16.4","@openedx/frontend-plugin-framework":"^1.1.2"},"peerDependencies":{"react":"^16.9.0 || ^17.0.0","react-dom":"^16.9.0 || ^17.0.0","prop-types":"^15.5.10","@openedx/paragon":">= 21.11.3 < 23.0.0","@edx/frontend-platform":"^7.0.0 || ^8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/frontend-component-footer-bilisim_1.1.0_1729778063177_0.9707421893811714","host":"s3://npm-registry-packages"}},"1.2.0":{"name":"@artistanbul/frontend-component-footer-bilisim","version":"1.2.0","description":"Footer component for use when building Open edX frontend applications","main":"dist/index.js","publishConfig":{"access":"public"},"scripts":{"build":"make build","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","start:with-theme":"paragon install-theme && npm start && npm install","test":"fedx-scripts jest --coverage"},"husky":{"hooks":{"pre-commit":"npm run lint"}},"repository":{"type":"git","url":"git+https://github.com/openedx/frontend-component-footer.git"},"author":{"name":"edX"},"license":"AGPL-3.0","bugs":{"url":"https://github.com/openedx/frontend-component-footer/issues"},"homepage":"https://github.com/openedx/frontend-component-footer#readme","devDependencies":{"@edx/brand":"npm:@openedx/brand-openedx@^1.2.2","@edx/browserslist-config":"^1.1.1","@edx/frontend-platform":"8.1.2","@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","prop-types":"15.8.1","react":"17.0.2","react-dom":"17.0.2","react-redux":"7.2.9","react-router-dom":"6.27.0","react-test-renderer":"17.0.2","redux":"4.2.1","semantic-release":"21.1.2"},"dependencies":{"@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 || ^8.0.0","@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"},"gitHead":"566b8e5fb08400db1fd113105aa413647dd3747a","_id":"@artistanbul/frontend-component-footer-bilisim@1.2.0","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-nm8tFfT3PFQUjDekkvEiHqBFLcZbbumisfX25yhH4f8ZferX14tB+G3xMbRsUdiDOnOQ9IeIdCCnRVO8qixV2g==","shasum":"01904951e84b4bd3f6b264cdf074ae581609bd01","tarball":"https://registry.npmjs.org/@artistanbul/frontend-component-footer-bilisim/-/frontend-component-footer-bilisim-1.2.0.tgz","fileCount":32,"unpackedSize":268166,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDlf20stU9bavDJQMBEswgqlCo8L6l9VccnoYWbRJtcfgIgYpPfM1cOUxn2NAPVt4QU5JFjr5AZRoGlmS56ZTvuFjY="}]},"_npmUser":{"name":"artistanbul","email":"developers@artistanbul.io"},"directories":{},"maintainers":[{"name":"artistanbul","email":"developers@artistanbul.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/frontend-component-footer-bilisim_1.2.0_1729786399979_0.8653268808314591"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-24T13:54:23.077Z","modified":"2024-10-24T16:13:20.394Z","1.1.0":"2024-10-24T13:54:23.390Z","1.2.0":"2024-10-24T16:13:20.228Z"},"bugs":{"url":"https://github.com/openedx/frontend-component-footer/issues"},"author":{"name":"edX"},"license":"AGPL-3.0","homepage":"https://github.com/openedx/frontend-component-footer#readme","repository":{"type":"git","url":"git+https://github.com/openedx/frontend-component-footer.git"},"description":"Footer component for use when building Open edX frontend applications","maintainers":[{"name":"artistanbul","email":"developers@artistanbul.io"}],"readme":"#########################\nfrontend-component-footer\n#########################\n\n|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|\n\n********\nPurpose\n********\n\nA generic footer for Open edX micro-frontend applications.  It includes a logo and an optional language selector dropdown.\n\n***************\nGetting Started\n***************\n\nPrerequisites\n=============\n\nThe `devstack`_ is currently recommended as a development environment for your\nnew MFE.  If you start it with ``make dev.up.lms`` that should give you\neverything you need as a companion to this frontend.\n\nNote that it is also possible to use `Tutor`_ to develop an MFE.  You can refer\nto the `relevant tutor-mfe documentation`_ to get started using it.\n\n.. _Devstack: https://github.com/openedx/devstack\n\n.. _Tutor: https://github.com/overhangio/tutor\n\n.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development\n\nRequirements\n============\n\nThis 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>`_\n\nEnvironment Variables\n=====================\n\nThis component requires that the following environment variable be set by the consuming micro-frontend.\n\n* ``LMS_BASE_URL`` - The URL of the LMS of your Open edX instance.\n* ``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.\n\nInstallation\n============\n\nTo install this footer into your Open edX micro-frontend, run the following command in your MFE:\n\n``npm i --save @edx/frontend-component-footer``\n\nThis will make the component available to be imported into your application.\n\nCloning and Startup\n===================\n\n.. code-block::\n\n\n  1. Clone your new repo:\n\n    ``git clone https://github.com/openedx/frontend-component-footer.git``\n\n  2. Use node v18.x.\n\n    The current version of the micro-frontend build scripts support node 18.\n    Using other major versions of node *may* work, but this is unsupported.  For\n    convenience, this repository includes an .nvmrc file to help in setting the\n    correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.\n\n  3. Install npm dependencies:\n\n    ``cd frontend-component-footer && npm ci``\n\n  4. Start the dev server:\n\n    ``npm start``\n\nUsage\n=====\n\nThis library has the following exports:\n\n* ``(default)``: The footer as a React component.\n* ``messages``: Internationalization messages suitable for use with `@edx/frontend-platform/i18n <https://edx.github.io/frontend-platform/module-Internationalization.html>`_\n* ``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.\n\n<Footer /> component props\n==========================\n\n* onLanguageSelected: Provides the footer with an event handler for when the user selects a\n  language from its dropdown.\n* supportedLanguages: An array of objects representing available languages.  See example below for object shape.\n\nPlugin\n======\nThe footer can be replaced using using `Frontend Plugin Framework <https://github.com/openedx/frontend-plugin-framework>`_.\n\nInformation 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/>`_.\n\nExamples\n========\n\nComponent Usage Example::\n\n  import Footer, { messages } from '@edx/frontend-component-footer';\n\n  ...\n\n  <Footer\n    onLanguageSelected={(languageCode) => {/* set language */}}\n    supportedLanguages={[\n      { label: 'English', value: 'en'},\n      { label: 'Español', value: 'es' },\n    ]}\n  />\n\n* `An example of minimal component and messages usage. <https://github.com/openedx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx#L23>`_\n* `An example of SCSS file usage. <https://github.com/openedx/frontend-template-application/blob/3cd5485bf387b8c479baf6b02bf59e3061dc3465/src/index.scss#L9>`_\n\n\n\nDevelopment\n===========\n\nInstall dependencies::\n\n  npm i\n\nStart the development server::\n\n  npm start\n\nBuild a production distribution::\n\n  npm run build\n\nLicense\n=======\n\nThe code in this repository is licensed under the AGPLv3 unless otherwise\nnoted.\n\nPlease see `LICENSE <LICENSE>`_ for details.\n\nContributing\n============\n\nContributions are very welcome.  Please read `How To Contribute`_ for details.\n\n.. _How To Contribute: https://openedx.org/r/how-to-contribute\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features.  However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nGetting Help\n===========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.  Because this is a\nfrontend repository, the best place to discuss it would be in the `#wg-frontend\nchannel`_.\n\nFor anything non-trivial, the best path is to open an issue in this repository\nwith as many details about the issue you are facing as you can provide.\n\nhttps://github.com/openedx/frontend-component-footer/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6\n.. _Getting Help: https://openedx.org/community/connect\n\nThe Open edX Code of Conduct\n============================\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-footer.svg?branch=master\n   :target: https://travis-ci.com/edx/frontend-component-footer\n.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-footer\n   :target: @edx/frontend-component-footer\n.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-footer.svg\n   :target: @edx/frontend-component-footer\n.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-footer.svg\n   :target: @edx/frontend-component-footer\n.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-footer.svg\n   :target: @edx/frontend-component-footer\n.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :target: https://github.com/semantic-release/semantic-release\n","readmeFilename":"README.rst"}