{"_id":"@artistanbul/frontend-component-header-bilisim","name":"@artistanbul/frontend-component-header-bilisim","dist-tags":{"latest":"1.1.0"},"versions":{"1.1.0":{"name":"@artistanbul/frontend-component-header-bilisim","version":"1.1.0","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/openedx/frontend-component-header.git"},"author":{"name":"edX"},"license":"AGPL-3.0","bugs":{"url":"https://github.com/openedx/frontend-component-header/issues"},"homepage":"https://github.com/openedx/frontend-component-header#readme","devDependencies":{"@edx/brand":"npm:@edx/brand-openedx@1.2.0","@edx/browserslist-config":"^1.1.1","@edx/frontend-build":"^12.4.19","@edx/frontend-platform":"^3.0.1","@edx/reactifex":"^2.1.1","@testing-library/dom":"9.0.1","@testing-library/jest-dom":"5.16.5","@testing-library/react":"10.4.9","enzyme":"3.11.0","enzyme-adapter-react-16":"1.15.7","husky":"8.0.3","jest":"29.5.0","jest-chain":"1.1.6","prop-types":"15.8.1","react":"16.14.0","react-dom":"16.14.0","react-redux":"7.2.9","react-router-dom":"5.3.4","react-test-renderer":"16.14.0","redux":"4.2.1","redux-saga":"1.2.2"},"dependencies":{"@edx/paragon":"20.28.4","@fortawesome/fontawesome-svg-core":"6.3.0","@fortawesome/free-brands-svg-icons":"6.3.0","@fortawesome/free-regular-svg-icons":"6.3.0","@fortawesome/free-solid-svg-icons":"6.3.0","@fortawesome/react-fontawesome":"^0.2.0","babel-polyfill":"6.26.0","react-responsive":"8.2.0","react-transition-group":"4.4.5"},"peerDependencies":{"@edx/frontend-platform":"^2.0.0 || ^3.0.0","prop-types":"^15.5.10","react":"^16.9.0","react-dom":"^16.9.0"},"gitHead":"7062cb40e16209f5eb41362b31615de606035b37","_id":"@artistanbul/frontend-component-header-bilisim@1.1.0","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-he2LPL0LVU0cR4z/2si07lQZA57tyYAokGZWJ0yEjmwqLrajCw1O9IEnYsyR0vhAZijSjhHJFHlQTiifTCoz5w==","shasum":"cc272952a22acf86be77599be8e7cba9d5425191","tarball":"https://registry.npmjs.org/@artistanbul/frontend-component-header-bilisim/-/frontend-component-header-bilisim-1.1.0.tgz","fileCount":56,"unpackedSize":383694,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID2W/74wK2y96paSE80WI3lWfoIejkLh8Pzfb7N17+iDAiBGqB+Fuk2YjPwSh5orqdkhiNrygWejnQpU1va2PeSRIg=="}]},"_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-header-bilisim_1.1.0_1729693092226_0.005466054173076884"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-23T14:18:12.101Z","1.1.0":"2024-10-23T14:18:12.550Z","modified":"2024-10-23T14:18:12.857Z"},"maintainers":[{"name":"artistanbul","email":"developers@artistanbul.io"}],"description":"The standard header for Open edX","homepage":"https://github.com/openedx/frontend-component-header#readme","repository":{"type":"git","url":"git+https://github.com/openedx/frontend-component-header.git"},"author":{"name":"edX"},"bugs":{"url":"https://github.com/openedx/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. `_\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* ``ACCOUNT_PROFILE_URL`` - The URL of the account profile page.\n* ``ACCOUNT_SETTINGS_URL`` - The URL of the account settings 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 `_\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. `_\n* `An example of SCSS file usage. `_\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"}