{"_id":"@cucwd-prod/frontend-component-header","_rev":"2-c2baca95d7d232a98f1aef322f825f6a","name":"@cucwd-prod/frontend-component-header","dist-tags":{"latest":"2.4.5-nutmeg.2"},"versions":{"2.4.3-maple.3":{"name":"@cucwd-prod/frontend-component-header","description":"The standard header for Open edX","main":"dist/index.js","publishConfig":{"access":"public"},"scripts":{"build":"make build","i18n_extract":"BABEL_ENV=i18n fedx-scripts babel src --quiet > /dev/null","lint":"fedx-scripts eslint --ext .js --ext .jsx .","snapshot":"fedx-scripts jest --updateSnapshot","start":"fedx-scripts webpack-dev-server --progress","test":"fedx-scripts jest --coverage"},"husky":{"hooks":{"pre-commit":"npm run lint"}},"repository":{"type":"git","url":"git+https://github.com/CUCWD/frontend-component-header.git"},"author":{"name":"edX, CUCWD"},"license":"AGPL-3.0","bugs":{"url":"https://github.com/CUCWD/frontend-component-header/issues"},"homepage":"https://github.com/CUCWD/frontend-component-header#readme","devDependencies":{"@edx/brand":"npm:@edx/brand-openedx@1.1.0","@edx/frontend-build":"npm:@cucwd-prod/frontend-build@9.0.5-maple.3","@edx/frontend-platform":"npm:@cucwd-prod/frontend-platform@1.14.4-maple.3","@edx/paragon":"12.8.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.14.0","react-dom":"16.14.0","react-redux":"7.2.6","react-router-dom":"5.3.0","react-test-renderer":"16.14.0","reactifex":"1.1.1","redux":"4.1.2","redux-saga":"1.1.3","@testing-library/dom":"7.31.2","@testing-library/jest-dom":"5.16.1","jest":"27.3.1","jest-chain":"1.1.5","@testing-library/react":"10.3.0"},"dependencies":{"babel-polyfill":"6.26.0","react-responsive":"8.2.0","react-transition-group":"4.4.2","@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.14"},"peerDependencies":{"@edx/frontend-platform":"npm:@cucwd-prod/frontend-platform@1.14.4-maple.3","@edx/paragon":">= ^7.0.0 < 13.0.0","prop-types":"^15.5.10","react":"^16.9.0","react-dom":"^16.9.0"},"version":"2.4.3-maple.3","gitHead":"105654c78ebc9806f301c97ce37ec463cc291512","_id":"@cucwd-prod/frontend-component-header@2.4.3-maple.3","_nodeVersion":"12.22.12","_npmVersion":"6.14.16","dist":{"integrity":"sha512-Q0BUFQDF8FgHC9n8qqZg7X/Oa4jT971uS37K+UYPpPMyRN/21SJ1h4Lsnyl7qOlaYbTBY2lCJ4x3zXnH7ebghQ==","shasum":"475968129c89fd65b53797b289e262943639b674","tarball":"https://registry.npmjs.org/@cucwd-prod/frontend-component-header/-/frontend-component-header-2.4.3-maple.3.tgz","fileCount":54,"unpackedSize":204045,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDm//vYrnOcWuOYr1LH2QfVX9GTH79xRqbWQU31SZN/bgIgDEeCt1fyi94n9EZvQ6KSZNFOtB7vvlpvH5yzyV0p8UE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjXDEmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrI5Q//TM3lAArBiL2CDjdiRfFHIvOFE3HDDopO6RTYGOhDfaKLcrD0\r\nz7UY5+LAMC6yCUoRTFCfEQSV7oLf1hkUahi3GuitLdgl0aHBTm06vL2kizu4\r\nxaWHtc8Hn7kvmlSXOnKCb9jWl4oswW7L92xtMrtKgNiKUzIjHHva7d6vypvA\r\nOjnN5YUMAPDDvc23RN8Fo1aQDXEaVmOP542yJJXb5NkJCpzE83NlC10KGJwP\r\n/x1jm9BY/RyJFYJqVuR8jW6dLq6PyYndcuAYpEjMZwCrerlTLy9BlbXNfgPb\r\nh6ayQVqnaYUpdx6vxGPnYESk6FreIC3lINcK0vSblEm7UuSCWUIVupkpJRkD\r\nhIHi6B5kU9E3yY277qm5Z908N9q0YONZVuR2jNhtTU+VdIMi+2rXX0WqKlv3\r\nl8paCubEIDPCyHv0jBDjXzxOK0YyKFZGVJTxLBjNcGqLSf2ftkKT+IAgzSXY\r\nnieGH1ptpDdUJZO64CQABp1NfcIcA7SKCF7hr3vE5h8cBejeoiX/9BRMwggb\r\nktrUkwhGnipYaFzA9DHgNwo7KdJ+9w3TrpjDLZstUMTRKjV8PWZk+Ew/UX7f\r\nKBBX3fDIZXdCkokAMP+GmsUbUO6L7rRPCSOjT4Sjpol8wpzKapw3EYKWqRnM\r\n+IHYsjq6Ee1/FyR7YOP9jQ1UMgEmxh0k41o=\r\n=ECza\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"},"directories":{},"maintainers":[{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/frontend-component-header_2.4.3-maple.3_1666986278745_0.6450931875826222"},"_hasShrinkwrap":false},"2.4.3-maple.3.2-no-cache":{"name":"@cucwd-prod/frontend-component-header","description":"The standard header for Open edX","main":"dist/index.js","publishConfig":{"access":"public"},"scripts":{"build":"make build","i18n_extract":"BABEL_ENV=i18n fedx-scripts babel src --quiet > /dev/null","lint":"fedx-scripts eslint --ext .js --ext .jsx .","snapshot":"fedx-scripts jest --updateSnapshot","start":"fedx-scripts webpack-dev-server --progress","test":"fedx-scripts jest --coverage"},"husky":{"hooks":{"pre-commit":"npm run lint"}},"repository":{"type":"git","url":"git+https://github.com/CUCWD/frontend-component-header.git"},"author":{"name":"edX, CUCWD"},"license":"AGPL-3.0","bugs":{"url":"https://github.com/CUCWD/frontend-component-header/issues"},"homepage":"https://github.com/CUCWD/frontend-component-header#readme","devDependencies":{"@edx/brand":"npm:@edx/brand-openedx@1.1.0","@edx/frontend-build":"npm:@cucwd-prod/frontend-build@9.0.5-maple.3","@edx/frontend-platform":"npm:@cucwd-prod/frontend-platform@1.14.4-maple.3.1-no-cache","@edx/paragon":"12.8.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.14.0","react-dom":"16.14.0","react-redux":"7.2.6","react-router-dom":"5.3.0","react-test-renderer":"16.14.0","reactifex":"1.1.1","redux":"4.1.2","redux-saga":"1.1.3","@testing-library/dom":"7.31.2","@testing-library/jest-dom":"5.16.1","jest":"27.3.1","jest-chain":"1.1.5","@testing-library/react":"10.3.0"},"dependencies":{"babel-polyfill":"6.26.0","react-responsive":"8.2.0","react-transition-group":"4.4.2","@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.14"},"peerDependencies":{"@edx/frontend-platform":"npm:@cucwd-prod/frontend-platform@1.14.4-maple.3.1-no-cache","@edx/paragon":">= ^7.0.0 < 13.0.0","prop-types":"^15.5.10","react":"^16.9.0","react-dom":"^16.9.0"},"version":"2.4.3-maple.3.2-no-cache","gitHead":"959596f70198b7fe43d014802f0518a997213ded","_id":"@cucwd-prod/frontend-component-header@2.4.3-maple.3.2-no-cache","_nodeVersion":"12.22.12","_npmVersion":"6.14.16","dist":{"integrity":"sha512-gdzTrDQNdZr7QGKM9K38yFJfGaVOvO5XcQKFGUCmf+2AT0fU+wohmedpY9Y/aXm23YFw/s3xXTYUCZOj/8Ed1g==","shasum":"6f5ed83a896b776c105c3b1249e1c7f5a5d0d0b6","tarball":"https://registry.npmjs.org/@cucwd-prod/frontend-component-header/-/frontend-component-header-2.4.3-maple.3.2-no-cache.tgz","fileCount":54,"unpackedSize":204078,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICD25ebgTVNOK/0bIWETciM7dPChP3IVy9cvhalc5eaWAiAnZCvvCqNtKJRJRPIiHuA6/tB5ZQaZ8/0syxCUwyD1dg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjZLFOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpnAA//XwwXx6+Z1c9lDezObEdvgKUiP1SB/jQV8zTZzP+g0XR6COMb\r\nPLFlfk3wrZvJxmDy+GbwSblRmOXzBWzk9AzcbThd+dG5gSxhxwRN15f/V0/w\r\n6qvoEV1SNrirxtaQVjfgoJiv3hzwFKJN9/v0Y1iggMiPjk4MhSPq9vY4TCsz\r\nXMFeeamv/jGWNCy5T9e5ClvFYeNzFo3cInWsYB0l/uYbsXIApQNVIvc+djxQ\r\nbq3vpAFnl4PpyOqgiTmZ30yX1wM9Z0vbEm5zzSRCY78ylNrJ8o1k0GEvu0l5\r\nKc92rUUYjntKjRa/95dmlwzzdRF81XzQOlAHtVG1/oEzgbbmML1QUX+7iy8N\r\nXiP1w8vlLbwgSuJdlyV4nxXGSq/Sp5+nF+gfb+PAWsvPlkSGmZ9KJaPtWked\r\nNSJvdmcvjxp+UfARODWOgaHGuMtK1c98PlFk23pjGxWLoHgxcKS3+MGCyPkH\r\nWYgoTPk3xNTQ6D2QdDSwD6qYVC9h3F/zbNbyzqjXSZp1H6fHcZBXXvfeg33b\r\nbmysrkJ6/zh1mluSxwP5SlJLBabeSB7e5PbBR/y8XA6YcV0/LPcd9jBaPqQP\r\nKnYhV9zXrrzVFIcNwk1CczU5AAxkcWGrmmOLsx6qqGC5UEcyf73bFAQPM8Ra\r\nHqkBJVEvIACVFj7Gol6aR/cVK+42bjfE0oI=\r\n=gfzz\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"},"directories":{},"maintainers":[{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/frontend-component-header_2.4.3-maple.3.2-no-cache_1667543374717_0.9051790501029202"},"_hasShrinkwrap":false},"2.4.5-nutmeg.2":{"name":"@cucwd-prod/frontend-component-header","description":"The standard header for Open edX","main":"dist/index.js","publishConfig":{"access":"public"},"scripts":{"build":"make build","i18n_extract":"BABEL_ENV=i18n fedx-scripts babel src --quiet > /dev/null","lint":"fedx-scripts eslint --ext .js --ext .jsx .","snapshot":"fedx-scripts jest --updateSnapshot","start":"fedx-scripts webpack-dev-server --progress","test":"fedx-scripts jest --coverage"},"husky":{"hooks":{"pre-commit":"npm run lint"}},"repository":{"type":"git","url":"git+https://github.com/cucwd/frontend-component-header.git"},"author":{"name":"edX, CUCWD"},"license":"AGPL-3.0","bugs":{"url":"https://github.com/cucwd/frontend-component-header/issues"},"homepage":"https://github.com/cucwd/frontend-component-header#readme","devDependencies":{"@edx/brand":"npm:@edx/brand-openedx@1.1.0","@edx/frontend-build":"npm:@cucwd-prod/frontend-build@9.0.5-maple.3","@edx/frontend-platform":"npm:@cucwd-prod/frontend-platform@1.15.6-nutmeg.2","@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.8.1","react":"16.14.0","react-dom":"16.14.0","react-redux":"7.2.6","react-router-dom":"5.3.0","react-test-renderer":"16.14.0","reactifex":"1.1.1","redux":"4.1.2","redux-saga":"1.1.3","@testing-library/dom":"7.31.2","@testing-library/jest-dom":"5.16.2","jest":"27.5.0","jest-chain":"1.1.5","@testing-library/react":"10.4.9"},"dependencies":{"babel-polyfill":"6.26.0","react-responsive":"8.2.0","react-transition-group":"4.4.2","@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.14"},"peerDependencies":{"@edx/frontend-platform":"npm:@cucwd-prod/frontend-platform@1.15.6-nutmeg.2","@edx/paragon":">= 7.0.0 < 20.0.0","prop-types":"^15.5.10","react":"^16.9.0","react-dom":"^16.9.0"},"version":"2.4.5-nutmeg.2","gitHead":"ab57790739966c5da0c2cccf1c806cba9dcd9811","_id":"@cucwd-prod/frontend-component-header@2.4.5-nutmeg.2","_nodeVersion":"12.22.12","_npmVersion":"6.14.16","dist":{"integrity":"sha512-kGvGLvd71UVXPs0eN4rY+4SnMCH5kUtXYlSeAEQQ8Xw28r9wzi5SWAWSloBb4bkPczQwvizwOEImstnByoqEyA==","shasum":"c08edb0081de7c7e2e79e49ec2c1ce51e75d59cf","tarball":"https://registry.npmjs.org/@cucwd-prod/frontend-component-header/-/frontend-component-header-2.4.5-nutmeg.2.tgz","fileCount":54,"unpackedSize":206306,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCO7cwzAdNU8UqYQy5ThG+3Oj1kJ4Urq2WEKVotDAd0TAIhAK7eGkzMUucrCgDpONC9Wo2I+rKXUEh5mYrzNP5Pk26U"}]},"_npmUser":{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"},"directories":{},"maintainers":[{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/frontend-component-header_2.4.5-nutmeg.2_1715802104237_0.8318777755219742"},"_hasShrinkwrap":false}},"time":{"created":"2022-10-28T19:44:38.683Z","2.4.3-maple.3":"2022-10-28T19:44:38.895Z","modified":"2024-05-15T19:41:44.618Z","2.4.3-maple.3.2-no-cache":"2022-11-04T06:29:34.853Z","2.4.5-nutmeg.2":"2024-05-15T19:41:44.434Z"},"maintainers":[{"name":"sc.workforce.development","email":"sc.workforce.development@gmail.com"}],"description":"The standard header for Open edX","homepage":"https://github.com/cucwd/frontend-component-header#readme","repository":{"type":"git","url":"git+https://github.com/cucwd/frontend-component-header.git"},"author":{"name":"edX, CUCWD"},"bugs":{"url":"https://github.com/cucwd/frontend-component-header/issues"},"license":"AGPL-3.0","readme":"#########################\nfrontend-component-header\n#########################\n\n|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|\n\n********\nOverview\n********\n\nA generic header for Open edX micro-frontend applications.\n\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/edx/frontend-template-application/blob/master/src/index.jsx>`_\n\nEnvironment Variables\n=====================\n\n* ``LMS_BASE_URL`` - The URL of the LMS of your Open edX instance.\n* ``LOGOUT_URL`` - The URL of the API endpoint which performs a user logout.\n* ``LOGIN_URL`` - The URL of the login page where a user can sign into their account.\n* ``SITE_NAME`` - The user-facing name of the site, used as `alt` text on the logo in the header.\n  Defaults to \"localhost\" in development.\n* ``LOGO_URL`` - The URL of the site's logo.  This logo is displayed in the header.\n* ``ORDER_HISTORY_URL`` - The URL of the order history page.\n* ``AUTHN_MINIMAL_HEADER`` - A boolean flag which hides the main menu, user menu, and logged-out\n  menu items when truthy.  This is intended to be used in micro-frontends like\n  frontend-app-authentication in which these menus are considered distractions from the user's task.\n\n************\nInstallation\n************\n\nTo install this header into your Open edX micro-frontend, run the following command in your MFE:\n\n``npm i --save @edx/frontend-component-header``\n\nThis will make the component available to be imported into your application.\n\n*****\nUsage\n*****\n\nThis library has the following exports:\n\n* ``(default)``: The header 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/index.scss``: A SASS file which contains style information for the component.  It should be imported into the micro-frontend's own SCSS file.\n\nExamples\n========\n\n* `An example of component and messages usage. <https://github.com/edx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx#L21>`_\n* `An example of SCSS file usage. <https://github.com/edx/frontend-template-application/blob/3cd5485bf387b8c479baf6b02bf59e3061dc3465/src/index.scss#L8>`_\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\n.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-header.svg?branch=master\n   :target: https://travis-ci.com/edx/frontend-component-header\n.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-header\n   :target: @edx/frontend-component-header\n.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-header.svg\n   :target: @edx/frontend-component-header\n.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-header.svg\n   :target: @edx/frontend-component-header\n.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header.svg\n   :target: @edx/frontend-component-header\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"}