forked from openedx/frontend-component-header
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update env var for organization logos. * Update installation instructions.
- Loading branch information
1 parent
9e91340
commit 8f5e839
Showing
2 changed files
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,14 +29,16 @@ Environment Variables | |
* ``AUTHN_MINIMAL_HEADER`` - A boolean flag which hides the main menu, user menu, and logged-out | ||
menu items when truthy. This is intended to be used in micro-frontends like | ||
frontend-app-authentication in which these menus are considered distractions from the user's task. | ||
* ``ENABLE_ORG_LOGO`` - A boolean flag to enable the display of the org logo on the center of the | ||
header nav bar. Defaults to **false** | ||
|
||
************ | ||
Installation | ||
************ | ||
|
||
To install this header into your Open edX micro-frontend, run the following command in your MFE: | ||
|
||
``npm i --save @edx/frontend-component-header`` | ||
``npm i --save @nauedu/frontend-component-header`` | ||
|
||
This will make the component available to be imported into your application. | ||
|
||
|
@@ -73,6 +75,30 @@ Build a production distribution:: | |
|
||
npm run build | ||
|
||
*********** | ||
Publishing to npmjs.com | ||
*********** | ||
|
||
Any changes to this library have to be pushed to npmjs.com to be reflected on the build. | ||
|
||
Publish to npm:: | ||
|
||
npm publish | ||
|
||
|
||
*********** | ||
Deploy in production | ||
*********** | ||
To replace the default edx header with the new one, use one of the following instructions: | ||
|
||
Add the necessary settings to the mfe_brand plugin:: | ||
|
||
RUN npm install '@edx/frontend-component-header@npm:@nauedu/frontend-component-header' | ||
|
||
Alternatively, you can specify the version:: | ||
|
||
RUN npm install '@edx/frontend-component-header@npm:@nauedu/[email protected]' | ||
|
||
.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-header.svg?branch=master | ||
:target: https://travis-ci.com/edx/frontend-component-header | ||
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-header | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters