@edx/frontend-component-header-edx

The standard header for edX

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@edx/frontend-component-header-edx
1196.3.511 days ago3 years agoMinified + gzip package size for @edx/frontend-component-header-edx in KB

Readme

frontend-component-header-edx
|npmversion| |npmdownloads| |license|
This is the standard edX header for use in React applications. It has two exports:
  • default: The Header Component
  • messages: for i18n in the form of `{ locale: { key: translatedString } }`

Usage

`import Header, { messages } from '@edx/frontend-component-header-edx';`

Development

  • Install requirements npm install
  • Install peer dependencies npm install @edx/frontend-analytics @edx/frontend-base @edx/frontend-i18n prop-types react
  • Start the example server npm start
  • Visit http://localhost:1234

.. |npmversion| image:: https://img.shields.io/npm/v/@edx/frontend-component-header-edx.svg
:target: https://www.npmjs.com/package/@edx/frontend-component-header-edx
.. |npm
downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-header-edx.svg
:target: @edx/frontend-component-header-edx
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header-edx.svg
:target: https://github.com/edx/frontend-component-header-edx/blob/master/LICENSE