@yorekaid/frontend-component-header
v1.0.10
Published
The standard header for CLIP
Readme
clip-frontend-component-header
A custom frontend component header for CLIP.
This is a fork of @edx/frontend-component-header, tailored specifically for CLIP's needs, including Dark Mode and Light Mode support.
Environment Variables
LMS_BASE_URL- The URL of the LMS.LOGOUT_URL- The URL of the API endpoint which performs a user logout.LOGIN_URL- The URL of the login page where a user can sign into their account.SITE_NAME- The user-facing name of the site.LOGO_URL_LIGHT- The URL of the site's logo for Light Mode.LOGO_URL_DARK- The URL of the site's logo for Dark Mode.ORDER_HISTORY_URL- The URL of the order history page.ACCOUNT_PROFILE_URL- The URL of the account profile page.
Theming
This component supports an internal dark mode switch, tracking the state using the clip-theme-dark key in localStorage.
When dark mode is toggled, it automatically switches the logo between LOGO_URL_DARK and LOGO_URL_LIGHT, and overrides the dropdown menus and navigation texts appropriately.
Installation
npm install clip-frontend-component-header