fix: initial commit
This commit is contained in:
Adam Butterworth
33
.env
Normal file
33
.env
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
BASE_URL=localhost:1995
|
||||||
|
SITE_NAME=Open edX
|
||||||
|
LMS_BASE_URL=http://localhost:18000
|
||||||
|
CREDENTIALS_BASE_URL=http://localhost:18150
|
||||||
|
ECOMMERCE_BASE_URL=http://localhost:18130
|
||||||
|
LOGIN_URL=http://localhost:18000/login
|
||||||
|
LOGOUT_URL=http://localhost:18000/login
|
||||||
|
CSRF_TOKEN_API_PATH=/csrf/api/v1/token
|
||||||
|
REFRESH_ACCESS_TOKEN_ENDPOINT=http://localhost:18000/login_refresh
|
||||||
|
SEGMENT_KEY=ul
|
||||||
|
ACCESS_TOKEN_COOKIE_NAME=edx-jwt-cookie-header-payload
|
||||||
|
USER_INFO_COOKIE_NAME=edx-user-info
|
||||||
|
CSRF_COOKIE_NAME=csrftoken
|
||||||
|
LANGUAGE_PREFERENCE_COOKIE_NAME=openedx-language-preference
|
||||||
|
SITE_NAME=edX
|
||||||
|
MARKETING_SITE_BASE_URL=http://localhost:18000
|
||||||
|
ENTERPRISE_MARKETING_URL=http://example.com
|
||||||
|
ENTERPRISE_MARKETING_UTM_CAMPAIGN=my_campaign
|
||||||
|
ENTERPRISE_MARKETING_UTM_SOURCE=edX profile
|
||||||
|
ENTERPRISE_MARKETING_FOOTER_UTM_MEDIUM=Footer
|
||||||
|
SUPPORT_URL=http://localhost:18000/support
|
||||||
|
CONTACT_URL=http://localhost:18000/contact
|
||||||
|
OPEN_SOURCE_URL=http://localhost:18000/openedx
|
||||||
|
TERMS_OF_SERVICE_URL=http://localhost:18000/terms-of-service
|
||||||
|
PRIVACY_POLICY_URL=http://localhost:18000/privacy-policy
|
||||||
|
FACEBOOK_URL=https://www.facebook.com
|
||||||
|
TWITTER_URL=https://twitter.com
|
||||||
|
YOU_TUBE_URL=https://www.youtube.com
|
||||||
|
LINKED_IN_URL=https://www.linkedin.com
|
||||||
|
REDDIT_URL=https://www.reddit.com
|
||||||
|
APPLE_APP_STORE_URL=https://www.apple.com/ios/app-store/
|
||||||
|
GOOGLE_PLAY_URL=https://play.google.com/store
|
||||||
|
ORDER_HISTORY_URL=localhost:1996/orders
|
||||||
4
.eslintignore
Normal file
4
.eslintignore
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
coverage
|
||||||
|
dist
|
||||||
|
example
|
||||||
|
node_modules
|
||||||
19
.eslintrc.json
Normal file
19
.eslintrc.json
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"extends": "eslint-config-edx",
|
||||||
|
"parser": "babel-eslint",
|
||||||
|
"rules": {
|
||||||
|
"import/no-extraneous-dependencies": [
|
||||||
|
"error",
|
||||||
|
{
|
||||||
|
"devDependencies": [
|
||||||
|
"webpack.config.js",
|
||||||
|
"**/*.test.jsx",
|
||||||
|
"**/*.test.js"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"env": {
|
||||||
|
"jest": true
|
||||||
|
}
|
||||||
|
}
|
||||||
5
.gitignore
vendored
Normal file
5
.gitignore
vendored
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
.cache
|
||||||
|
.DS_Store
|
||||||
|
coverage
|
||||||
|
dist
|
||||||
|
node_modules
|
||||||
27
.releaserc
Normal file
27
.releaserc
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"branch": "master",
|
||||||
|
"tagFormat": "v${version}",
|
||||||
|
"verifyConditions": [
|
||||||
|
"@semantic-release/npm",
|
||||||
|
{
|
||||||
|
"path": "@semantic-release/github",
|
||||||
|
"assets": {
|
||||||
|
"path": "dist/*"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"analyzeCommits": "@semantic-release/commit-analyzer",
|
||||||
|
"generateNotes": "@semantic-release/release-notes-generator",
|
||||||
|
"prepare": "@semantic-release/npm",
|
||||||
|
"publish": [
|
||||||
|
"@semantic-release/npm",
|
||||||
|
{
|
||||||
|
"path": "@semantic-release/github",
|
||||||
|
"assets": {
|
||||||
|
"path": "dist/*"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"success": [],
|
||||||
|
"fail": []
|
||||||
|
}
|
||||||
17
.travis.yml
Normal file
17
.travis.yml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
language: node_js
|
||||||
|
node_js: 12
|
||||||
|
install:
|
||||||
|
- npm install
|
||||||
|
script:
|
||||||
|
- npm run lint
|
||||||
|
- npm run test
|
||||||
|
- npm run build
|
||||||
|
after_success:
|
||||||
|
- npm run semantic-release
|
||||||
|
- codecov
|
||||||
|
env:
|
||||||
|
global:
|
||||||
|
# GH_TOKEN
|
||||||
|
- secure: CFN/uOByWC+7S+AAXECLQ0mNgoiyCDl1ZB5AT5+/qP+xEVs0ysFKDWrD9W8KeQqHqCMPUKNt23nrgxwvFCkSx+n1MAnxZmOdVJWbzGbUB9TsqrwVUALkqof1MrRB8UFVEzIRaO60iRN/L3zVXML+4GsycYX6rHyptbAypxplpljDyKrY8tc/mM7AGZ9eVFGSq+7CXXmdvkhP9kLkH1tIYvR7wjTKvZHbHf6YRjIVCiyzxM4S/E9l8JRnbERp02XosRD62PUJXXk6EJVn6Qoub6CaPnpew5crW0iRF1UJs54U29zWd/S+LuW66WkLfJu7rDq6AFJNMtMNusJxwVkOv4X+p0oJDWZEhojW+/Wm10UAu8/g5oAqeePZEGiSbT3Hp1VqOc4FY/kmOLiM+L6oq/AA2XX6iiE8lA64IH5R8ApQamF4GTUYTvKHeLPgXnGJH7A95Xy9/+jmX9I9wJREMrHrkyPjoX/NTRdG+RrebB1+An9Bt9vAbG862gbOZfgTcuWHDOlG5gcA964Fr7RqR5a62yr45Gw+Q0lTrLj5mGAjjSpMRIAQzi9e7oXmoMZnvenu/WJAe5M+u+/gv82HeXcMwLvNNGSvz+0i1xNUOoX1zHG046oGKiX0Zu+l0JfNwihJTO7vJlaITmjhfOyufwpk74xEyrhf8nLF9e5Frec=
|
||||||
|
# NPM_TOKEN
|
||||||
|
- secure: fuV04Ctf0mgbw6nTJhsTzGZ6dyafZtGVj30ZkvSWsB9hUU8KDtl7wWVW9EayCQsSyyFgPY9RVav5olgC/zljAjDGg0nfF7n8uKIABA0TXdP683WZd06bVOmDXfL26B3yM83aW2xgHZN6VCCvCE8bLP1V6eV8nsr38gDgxVbHa0YasDMmvtYrog+IjxwjcJx7fD0RbYyi7iJC++pdw9kcFqOad28Us7L/jCn+rC3CmUT4kOwPjP5g1v5sB2FA7ouN5s1hUUTKuttV32VJgRP7wbZzoHeHX5BRGSqijdXNSaK5UwzqRnM1sGZkuNDZhJbSB3q90SQrPRgV+fRizwN8zs8Htb+Kk8+wGY6zNhmi9C+lUIv7UpDYbstMWYIf39+P/24Oj+vJBjMY30M9NWB8gt1OQ0dJUoK53v1+BMVmDB0doL6I53xwzUjQetvqOF0Wm3E3OrqJP00OJdzIcAeh2DzcIRW1SrBhI4HAsl7QJZNpRw11QzJ3K2iQSiWNd8qIuX+XJjzQdn1v09gCstvbP33Vn8tP1x0XTSi8wIhTDqE0bII/Sc80Jh76nu0ItQ8pmX4lGsER4C0N3Dp7Zz51yW7E70AWWLsUrMNdF0oHoP437ZRGPhYs5OI6x5AM2jlU8fJ5aUroEsYFCwkH0OO37THohpAQpApe9zL10miTEbw=
|
||||||
661
LICENSE
Normal file
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
|||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published
|
||||||
|
by the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
7
Makefile
Normal file
7
Makefile
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
build:
|
||||||
|
rm -rf ./dist
|
||||||
|
./node_modules/.bin/babel src --out-dir dist --source-maps --ignore **/*.test.jsx,**/__mocks__,**/__snapshots__,**/setupTest.js --copy-files
|
||||||
|
# --copy-files will bring in everything else that wasn't processed by babel. Remove what we don't want.
|
||||||
|
rm -rf dist/**/*.test.jsx
|
||||||
|
rm -rf dist/**/__snapshots__
|
||||||
|
rm -rf dist/__mocks__
|
||||||
19
README.rst
Normal file
19
README.rst
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
frontend-component-header
|
||||||
|
=========================
|
||||||
|
|
||||||
|
|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|
|
||||||
|
|
||||||
|
This repository is a work in progress. Nothing found here is at all production-ready.
|
||||||
|
|
||||||
|
.. |Build Status| image:: https://api.travis-ci.org/edx/frontend-component-header.svg?branch=master-edx
|
||||||
|
:target: https://travis-ci.org/edx/frontend-component-header
|
||||||
|
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-header
|
||||||
|
:target: @edx/frontend-component-header
|
||||||
|
.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-header.svg-edx
|
||||||
|
:target: @edx/frontend-component-header
|
||||||
|
.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-header.svg-edx
|
||||||
|
:target: @edx/frontend-component-header
|
||||||
|
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header.svg-edx
|
||||||
|
:target: @edx/frontend-component-header
|
||||||
|
.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
|
||||||
|
:target: https://github.com/semantic-release/semantic-release
|
||||||
22
babel.config.js
Normal file
22
babel.config.js
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [
|
||||||
|
[
|
||||||
|
'@babel/preset-env',
|
||||||
|
{
|
||||||
|
modules: false,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
'@babel/preset-react',
|
||||||
|
],
|
||||||
|
plugins: [
|
||||||
|
'@babel/plugin-proposal-object-rest-spread',
|
||||||
|
'@babel/plugin-proposal-class-properties',
|
||||||
|
],
|
||||||
|
env: {
|
||||||
|
test: {
|
||||||
|
presets: [
|
||||||
|
'@babel/preset-env',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
10
codecov.yml
Normal file
10
codecov.yml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
coverage:
|
||||||
|
status:
|
||||||
|
project:
|
||||||
|
default:
|
||||||
|
target: auto
|
||||||
|
threshold: 10%
|
||||||
|
patch:
|
||||||
|
default:
|
||||||
|
target: auto
|
||||||
|
threshold: 10%
|
||||||
3
commitlint.config.js
Normal file
3
commitlint.config.js
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
module.exports = {
|
||||||
|
extends: ['@commitlint/config-angular'],
|
||||||
|
};
|
||||||
10
example/.sassrc.js
Normal file
10
example/.sassrc.js
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
const path = require('path');
|
||||||
|
|
||||||
|
// Resolve ~tilda paths used in paragon to
|
||||||
|
// node_modules. This is used to reference
|
||||||
|
// bootstrap specifically.
|
||||||
|
module.exports = {
|
||||||
|
includePaths: [
|
||||||
|
path.resolve(__dirname, '../node_modules'),
|
||||||
|
],
|
||||||
|
};
|
||||||
12
example/index.html
Normal file
12
example/index.html
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en-us">
|
||||||
|
<head>
|
||||||
|
<title>Example</title>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
<script src="./index.js"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
35
example/index.js
Normal file
35
example/index.js
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { render } from 'react-dom';
|
||||||
|
import { IntlProvider } from '@edx/frontend-i18n';
|
||||||
|
import { AuthenticationContext } from '@edx/frontend-base';
|
||||||
|
|
||||||
|
import './index.scss';
|
||||||
|
import SiteHeader from '../src/';
|
||||||
|
|
||||||
|
const App = () => (
|
||||||
|
<div>
|
||||||
|
<IntlProvider locale="en">
|
||||||
|
<>
|
||||||
|
<AuthenticationContext.Provider value={{
|
||||||
|
userId: null,
|
||||||
|
username: null,
|
||||||
|
administrator: false,
|
||||||
|
}}>
|
||||||
|
<SiteHeader />
|
||||||
|
</AuthenticationContext.Provider>
|
||||||
|
<h5 className="mt-2 mb-5">Logged out state</h5>
|
||||||
|
|
||||||
|
<AuthenticationContext.Provider value={{
|
||||||
|
userId: null,
|
||||||
|
username: 'testuser',
|
||||||
|
administrator: false,
|
||||||
|
}}>
|
||||||
|
<SiteHeader />
|
||||||
|
</AuthenticationContext.Provider>
|
||||||
|
<h5 className="mt-2">Logged in state</h5>
|
||||||
|
</>
|
||||||
|
</IntlProvider>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
render(<App />, document.getElementById('root'));
|
||||||
2
example/index.scss
Normal file
2
example/index.scss
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
@import "~@edx/paragon/scss/core/core.scss";
|
||||||
|
@import '../src/index.scss';
|
||||||
18128
package-lock.json
generated
Normal file
18128
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
90
package.json
Normal file
90
package.json
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
{
|
||||||
|
"name": "@edx/frontend-component-header",
|
||||||
|
"version": "1.0.0-semantically-released",
|
||||||
|
"description": "The standard header for Open edX",
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
},
|
||||||
|
"main": "dist/index.js",
|
||||||
|
"scripts": {
|
||||||
|
"build": "make build",
|
||||||
|
"lint": "eslint --ext .js --ext .jsx .",
|
||||||
|
"semantic-release": "semantic-release",
|
||||||
|
"start": "parcel ./example/index.html --no-source-maps --out-dir example/dist",
|
||||||
|
"test": "jest --coverage --passWithNoTests"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"/dist",
|
||||||
|
"/src"
|
||||||
|
],
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/edx/frontend-component-header.git"
|
||||||
|
},
|
||||||
|
"author": "edX",
|
||||||
|
"license": "AGPL-3.0",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/edx/frontend-component-header/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/edx/frontend-component-header#readme",
|
||||||
|
"devDependencies": {
|
||||||
|
"@babel/cli": "^7.6.0",
|
||||||
|
"@babel/core": "^7.6.0",
|
||||||
|
"@babel/plugin-proposal-class-properties": "^7.5.5",
|
||||||
|
"@babel/plugin-proposal-object-rest-spread": "^7.5.5",
|
||||||
|
"@babel/preset-env": "^7.6.0",
|
||||||
|
"@babel/preset-react": "^7.0.0",
|
||||||
|
"@edx/frontend-analytics": "^2.0.0",
|
||||||
|
"@edx/frontend-auth": "^6.0.1",
|
||||||
|
"@edx/frontend-base": "^1.1.0",
|
||||||
|
"@edx/frontend-i18n": "^3.0.2",
|
||||||
|
"@edx/frontend-logging": "^3.0.1",
|
||||||
|
"@edx/paragon": "^7.1.2",
|
||||||
|
"babel-eslint": "^10.0.3",
|
||||||
|
"dotenv": "^8.1.0",
|
||||||
|
"enzyme": "^3.10.0",
|
||||||
|
"eslint": "^6.3.0",
|
||||||
|
"eslint-config-edx": "^4.0.4",
|
||||||
|
"jest": "^24.9.0",
|
||||||
|
"parcel-bundler": "^1.12.3",
|
||||||
|
"prop-types": "^15.7.2",
|
||||||
|
"react": "^16.9.0",
|
||||||
|
"react-dom": "^16.9.0",
|
||||||
|
"react-redux": "^7.1.1",
|
||||||
|
"react-router-dom": "^5.0.1",
|
||||||
|
"react-test-renderer": "^16.9.0",
|
||||||
|
"redux": "^4.0.4",
|
||||||
|
"redux-saga": "^1.0.5",
|
||||||
|
"sass": "^1.22.12",
|
||||||
|
"semantic-release": "^15.13.24"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@edx/frontend-base": "^1.1.0",
|
||||||
|
"@edx/frontend-i18n": "^3.0.2",
|
||||||
|
"prop-types": "^15.7.2",
|
||||||
|
"react": "^16.9.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"react-responsive": "^8.0.1",
|
||||||
|
"react-transition-group": "^4.3.0"
|
||||||
|
},
|
||||||
|
"jest": {
|
||||||
|
"transform": {
|
||||||
|
"^.+\\.jsx?$": "babel-jest"
|
||||||
|
},
|
||||||
|
"collectCoverageFrom": [
|
||||||
|
"src/**/*.{js,jsx}",
|
||||||
|
"!**/node_modules/**",
|
||||||
|
"!**/dist/**"
|
||||||
|
],
|
||||||
|
"moduleNameMapper": {
|
||||||
|
"\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/src/__mocks__/fileMock.js"
|
||||||
|
},
|
||||||
|
"transformIgnorePatterns": [
|
||||||
|
"/node_modules/(?!@edx)"
|
||||||
|
],
|
||||||
|
"setupFiles": [
|
||||||
|
"dotenv/config"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
5
renovate.json
Normal file
5
renovate.json
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"extends": [
|
||||||
|
"config:base"
|
||||||
|
]
|
||||||
|
}
|
||||||
42
src/Avatar.jsx
Normal file
42
src/Avatar.jsx
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
|
||||||
|
import { AvatarIcon } from './Icons';
|
||||||
|
|
||||||
|
function Avatar({
|
||||||
|
size,
|
||||||
|
src,
|
||||||
|
alt,
|
||||||
|
className,
|
||||||
|
}) {
|
||||||
|
const avatar = src ? (
|
||||||
|
<img className="d-block w-100 h-100" src={src} alt={alt} />
|
||||||
|
) : (
|
||||||
|
<AvatarIcon className="text-muted" style={{ width: size, height: size }} role="img" aria-hidden focusable="false" />
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<span
|
||||||
|
style={{ height: size, width: size }}
|
||||||
|
className={`avatar overflow-hidden d-inline-flex rounded-circle ${className}`}
|
||||||
|
>
|
||||||
|
{avatar}
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Avatar.propTypes = {
|
||||||
|
src: PropTypes.string,
|
||||||
|
size: PropTypes.string,
|
||||||
|
alt: PropTypes.string,
|
||||||
|
className: PropTypes.string,
|
||||||
|
};
|
||||||
|
|
||||||
|
Avatar.defaultProps = {
|
||||||
|
src: null,
|
||||||
|
size: '2rem',
|
||||||
|
alt: null,
|
||||||
|
className: null,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default Avatar;
|
||||||
167
src/DesktopHeader.jsx
Normal file
167
src/DesktopHeader.jsx
Normal file
@@ -0,0 +1,167 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
import { injectIntl, intlShape } from '@edx/frontend-i18n';
|
||||||
|
|
||||||
|
// Local Components
|
||||||
|
import { Menu, MenuTrigger, MenuContent } from './Menu';
|
||||||
|
import Avatar from './Avatar';
|
||||||
|
import { LinkedLogo, Logo } from './Logo';
|
||||||
|
|
||||||
|
// i18n
|
||||||
|
import messages from './SiteHeader.messages';
|
||||||
|
|
||||||
|
// Assets
|
||||||
|
import { CaretIcon } from './Icons';
|
||||||
|
|
||||||
|
class DesktopHeader extends React.Component {
|
||||||
|
constructor(props) { // eslint-disable-line no-useless-constructor
|
||||||
|
super(props);
|
||||||
|
}
|
||||||
|
|
||||||
|
renderMainMenu() {
|
||||||
|
const { mainMenu } = this.props;
|
||||||
|
|
||||||
|
// Nodes are accepted as a prop
|
||||||
|
if (!Array.isArray(mainMenu)) return mainMenu;
|
||||||
|
|
||||||
|
return mainMenu.map((menuItem) => {
|
||||||
|
const {
|
||||||
|
type,
|
||||||
|
href,
|
||||||
|
content,
|
||||||
|
submenuContent,
|
||||||
|
} = menuItem;
|
||||||
|
|
||||||
|
if (type === 'item') {
|
||||||
|
return (
|
||||||
|
<a key={`${type}-${content}`} className="nav-link" href={href}>{content}</a>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Menu key={`${type}-${content}`} tag="div" className="nav-item" respondToPointerEvents>
|
||||||
|
<MenuTrigger tag="a" className="nav-link d-inline-flex align-items-center" href={href}>
|
||||||
|
{content} <CaretIcon role="img" aria-hidden focusable="false" />
|
||||||
|
</MenuTrigger>
|
||||||
|
<MenuContent className="pin-left pin-right shadow py-2">
|
||||||
|
{submenuContent}
|
||||||
|
</MenuContent>
|
||||||
|
</Menu>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
renderUserMenu() {
|
||||||
|
const {
|
||||||
|
userMenu,
|
||||||
|
avatar,
|
||||||
|
username,
|
||||||
|
intl,
|
||||||
|
} = this.props;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Menu transitionClassName="menu-dropdown" transitionTimeout={250}>
|
||||||
|
<MenuTrigger
|
||||||
|
tag="button"
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.account.menu.for'], { username })}
|
||||||
|
className="btn btn-light d-inline-flex align-items-center pl-2 pr-3"
|
||||||
|
>
|
||||||
|
<Avatar size="1.5em" src={avatar} alt="" className="mr-2" />
|
||||||
|
{username} <CaretIcon role="img" aria-hidden focusable="false" />
|
||||||
|
</MenuTrigger>
|
||||||
|
<MenuContent className="mb-0 dropdown-menu show dropdown-menu-right pin-right shadow py-2">
|
||||||
|
{userMenu.map(({ type, href, content }) => (
|
||||||
|
<a className={`dropdown-${type}`} key={`${type}-${content}`} href={href}>{content}</a>
|
||||||
|
))}
|
||||||
|
</MenuContent>
|
||||||
|
</Menu>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
renderLoggedOutItems() {
|
||||||
|
const { loggedOutItems } = this.props;
|
||||||
|
|
||||||
|
return loggedOutItems.map((item, i, arr) => (
|
||||||
|
<a
|
||||||
|
key={`${item.type}-${item.content}`}
|
||||||
|
className={i < arr.length - 1 ? 'btn mr-2 btn-link' : 'btn mr-2 btn-outline-primary'}
|
||||||
|
href={item.href}
|
||||||
|
>
|
||||||
|
{item.content}
|
||||||
|
</a>
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
const {
|
||||||
|
logo,
|
||||||
|
logoAltText,
|
||||||
|
logoDestination,
|
||||||
|
loggedIn,
|
||||||
|
intl,
|
||||||
|
} = this.props;
|
||||||
|
const logoProps = { src: logo, alt: logoAltText, href: logoDestination };
|
||||||
|
|
||||||
|
return (
|
||||||
|
<header className="site-header-desktop">
|
||||||
|
<div className="container-fluid">
|
||||||
|
<div className="nav-container position-relative d-flex align-items-center">
|
||||||
|
{ logoDestination === null ? <Logo className="logo" src={logo} alt={logoAltText} /> : <LinkedLogo className="logo" {...logoProps} />}
|
||||||
|
<nav
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.main.nav'])}
|
||||||
|
className="nav main-nav"
|
||||||
|
>
|
||||||
|
{this.renderMainMenu()}
|
||||||
|
</nav>
|
||||||
|
<nav
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.secondary.nav'])}
|
||||||
|
className="nav secondary-menu-container align-items-center ml-auto"
|
||||||
|
>
|
||||||
|
{loggedIn ? this.renderUserMenu() : this.renderLoggedOutItems()}
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
DesktopHeader.propTypes = {
|
||||||
|
mainMenu: PropTypes.oneOfType([
|
||||||
|
PropTypes.node,
|
||||||
|
PropTypes.array,
|
||||||
|
]),
|
||||||
|
userMenu: PropTypes.arrayOf(PropTypes.shape({
|
||||||
|
type: PropTypes.oneOf(['item', 'menu']),
|
||||||
|
href: PropTypes.string,
|
||||||
|
content: PropTypes.string,
|
||||||
|
})),
|
||||||
|
loggedOutItems: PropTypes.arrayOf(PropTypes.shape({
|
||||||
|
type: PropTypes.oneOf(['item', 'menu']),
|
||||||
|
href: PropTypes.string,
|
||||||
|
content: PropTypes.string,
|
||||||
|
})),
|
||||||
|
logo: PropTypes.string,
|
||||||
|
logoAltText: PropTypes.string,
|
||||||
|
logoDestination: PropTypes.string,
|
||||||
|
avatar: PropTypes.string,
|
||||||
|
username: PropTypes.string,
|
||||||
|
loggedIn: PropTypes.bool,
|
||||||
|
|
||||||
|
// i18n
|
||||||
|
intl: intlShape.isRequired,
|
||||||
|
};
|
||||||
|
|
||||||
|
DesktopHeader.defaultProps = {
|
||||||
|
mainMenu: [],
|
||||||
|
userMenu: [],
|
||||||
|
loggedOutItems: [],
|
||||||
|
logo: null,
|
||||||
|
logoAltText: null,
|
||||||
|
logoDestination: null,
|
||||||
|
avatar: null,
|
||||||
|
username: null,
|
||||||
|
loggedIn: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default injectIntl(DesktopHeader);
|
||||||
46
src/Icons.jsx
Normal file
46
src/Icons.jsx
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
import React from 'react';
|
||||||
|
|
||||||
|
export const MenuIcon = props => (
|
||||||
|
<svg
|
||||||
|
width="24px"
|
||||||
|
height="24px"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
version="1.1"
|
||||||
|
{...props}
|
||||||
|
>
|
||||||
|
<rect fill="currentColor" x="2" y="5" width="20" height="2" />
|
||||||
|
<rect fill="currentColor" x="2" y="11" width="20" height="2" />
|
||||||
|
<rect fill="currentColor" x="2" y="17" width="20" height="2" />
|
||||||
|
</svg>
|
||||||
|
);
|
||||||
|
|
||||||
|
export const AvatarIcon = props => (
|
||||||
|
<svg
|
||||||
|
width="24px"
|
||||||
|
height="24px"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
version="1.1"
|
||||||
|
{...props}
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M4.10255106,18.1351061 C4.7170266,16.0581859 8.01891846,14.4720277 12,14.4720277 C15.9810815,14.4720277 19.2829734,16.0581859 19.8974489,18.1351061 C21.215206,16.4412566 22,14.3122775 22,12 C22,6.4771525 17.5228475,2 12,2 C6.4771525,2 2,6.4771525 2,12 C2,14.3122775 2.78479405,16.4412566 4.10255106,18.1351061 Z M12,24 C5.372583,24 0,18.627417 0,12 C0,5.372583 5.372583,0 12,0 C18.627417,0 24,5.372583 24,12 C24,18.627417 18.627417,24 12,24 Z M12,13 C9.790861,13 8,11.209139 8,9 C8,6.790861 9.790861,5 12,5 C14.209139,5 16,6.790861 16,9 C16,11.209139 14.209139,13 12,13 Z"
|
||||||
|
fill="currentColor"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
);
|
||||||
|
|
||||||
|
export const CaretIcon = props => (
|
||||||
|
<svg
|
||||||
|
width="16px"
|
||||||
|
height="16px"
|
||||||
|
viewBox="0 0 16 16"
|
||||||
|
version="1.1"
|
||||||
|
{...props}
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M7,4 L7,8 L11,8 L11,10 L5,10 L5,4 L7,4 Z"
|
||||||
|
fill="currentColor"
|
||||||
|
transform="translate(8.000000, 7.000000) rotate(-45.000000) translate(-8.000000, -7.000000) "
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
);
|
||||||
36
src/Logo.jsx
Normal file
36
src/Logo.jsx
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
|
||||||
|
|
||||||
|
function Logo({ src, alt, ...attributes }) {
|
||||||
|
return (
|
||||||
|
<img src={src} alt={alt} {...attributes} />
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Logo.propTypes = {
|
||||||
|
src: PropTypes.string.isRequired,
|
||||||
|
alt: PropTypes.string.isRequired,
|
||||||
|
};
|
||||||
|
|
||||||
|
function LinkedLogo({
|
||||||
|
href,
|
||||||
|
src,
|
||||||
|
alt,
|
||||||
|
...attributes
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<a href={href} {...attributes}>
|
||||||
|
<img className="d-block" src={src} alt={alt} />
|
||||||
|
</a>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
LinkedLogo.propTypes = {
|
||||||
|
href: PropTypes.string.isRequired,
|
||||||
|
src: PropTypes.string.isRequired,
|
||||||
|
alt: PropTypes.string.isRequired,
|
||||||
|
};
|
||||||
|
|
||||||
|
export { LinkedLogo, Logo };
|
||||||
|
export default Logo;
|
||||||
267
src/Menu/Menu.jsx
Normal file
267
src/Menu/Menu.jsx
Normal file
@@ -0,0 +1,267 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import { CSSTransition } from 'react-transition-group';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
|
||||||
|
|
||||||
|
function MenuTrigger({ tag, className, ...attributes }) {
|
||||||
|
return React.createElement(tag, {
|
||||||
|
className: `menu-trigger ${className}`,
|
||||||
|
...attributes,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
MenuTrigger.propTypes = {
|
||||||
|
tag: PropTypes.string,
|
||||||
|
className: PropTypes.string,
|
||||||
|
};
|
||||||
|
MenuTrigger.defaultProps = {
|
||||||
|
tag: 'div',
|
||||||
|
className: null,
|
||||||
|
};
|
||||||
|
const MenuTriggerType = <MenuTrigger />.type;
|
||||||
|
|
||||||
|
|
||||||
|
function MenuContent({ tag, className, ...attributes }) {
|
||||||
|
return React.createElement(tag, {
|
||||||
|
className: ['menu-content', className].join(' '),
|
||||||
|
...attributes,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
MenuContent.propTypes = {
|
||||||
|
tag: PropTypes.string,
|
||||||
|
className: PropTypes.string,
|
||||||
|
};
|
||||||
|
MenuContent.defaultProps = {
|
||||||
|
tag: 'div',
|
||||||
|
className: null,
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
class Menu extends React.Component {
|
||||||
|
constructor(props) {
|
||||||
|
super(props);
|
||||||
|
|
||||||
|
this.menu = React.createRef();
|
||||||
|
this.state = {
|
||||||
|
expanded: false,
|
||||||
|
};
|
||||||
|
|
||||||
|
this.onTriggerClick = this.onTriggerClick.bind(this);
|
||||||
|
this.onCloseClick = this.onCloseClick.bind(this);
|
||||||
|
this.onKeyDown = this.onKeyDown.bind(this);
|
||||||
|
this.onDocumentClick = this.onDocumentClick.bind(this);
|
||||||
|
this.onMouseEnter = this.onMouseEnter.bind(this);
|
||||||
|
this.onMouseLeave = this.onMouseLeave.bind(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lifecycle Events
|
||||||
|
componentWillUnmount() {
|
||||||
|
document.removeEventListener('touchend', this.onDocumentClick, true);
|
||||||
|
document.removeEventListener('click', this.onDocumentClick, true);
|
||||||
|
|
||||||
|
// Call onClose callback when unmounting and open
|
||||||
|
if (this.state.expanded && this.props.onClose) {
|
||||||
|
this.props.onClose();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Event handlers
|
||||||
|
onDocumentClick(e) {
|
||||||
|
if (!this.props.closeOnDocumentClick) return;
|
||||||
|
|
||||||
|
const clickIsInMenu = this.menu.current === e.target || this.menu.current.contains(e.target);
|
||||||
|
if (clickIsInMenu) return;
|
||||||
|
|
||||||
|
this.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
onTriggerClick(e) {
|
||||||
|
// Let the browser follow the link of the trigger if the menu
|
||||||
|
// is already expanded and the trigger has an href attribute
|
||||||
|
if (this.state.expanded && e.target.getAttribute('href')) return;
|
||||||
|
|
||||||
|
e.preventDefault();
|
||||||
|
this.toggle();
|
||||||
|
}
|
||||||
|
|
||||||
|
onCloseClick() {
|
||||||
|
this.getFocusableElements()[0].focus();
|
||||||
|
this.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
onKeyDown(e) {
|
||||||
|
if (!this.state.expanded) return;
|
||||||
|
switch (e.key) {
|
||||||
|
case 'Escape': {
|
||||||
|
e.preventDefault();
|
||||||
|
e.stopPropagation();
|
||||||
|
this.getFocusableElements()[0].focus();
|
||||||
|
this.close();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'Enter': {
|
||||||
|
// Using focusable elements instead of a ref to the trigger
|
||||||
|
// because Hyperlink and Button can handle refs as functional components
|
||||||
|
if (document.activeElement === this.getFocusableElements()[0]) {
|
||||||
|
e.preventDefault();
|
||||||
|
this.toggle();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'Tab': {
|
||||||
|
e.preventDefault();
|
||||||
|
if (e.shiftKey) {
|
||||||
|
this.focusPrevious();
|
||||||
|
} else {
|
||||||
|
this.focusNext();
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'ArrowDown': {
|
||||||
|
e.preventDefault();
|
||||||
|
this.focusNext();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case 'ArrowUp': {
|
||||||
|
e.preventDefault();
|
||||||
|
this.focusPrevious();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onMouseEnter() {
|
||||||
|
if (!this.props.respondToPointerEvents) return;
|
||||||
|
this.open();
|
||||||
|
}
|
||||||
|
|
||||||
|
onMouseLeave() {
|
||||||
|
if (!this.props.respondToPointerEvents) return;
|
||||||
|
this.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Internal functions
|
||||||
|
|
||||||
|
getFocusableElements() {
|
||||||
|
return this.menu.current.querySelectorAll('button:not([disabled]), [href]:not([disabled]), input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex="-1"]):not([disabled])');
|
||||||
|
}
|
||||||
|
|
||||||
|
getAttributesFromProps() {
|
||||||
|
// Any extra props are attributes for the menu
|
||||||
|
const attributes = {};
|
||||||
|
Object.keys(this.props)
|
||||||
|
.filter(property => Menu.propTypes[property] === undefined)
|
||||||
|
.forEach((property) => {
|
||||||
|
attributes[property] = this.props[property];
|
||||||
|
});
|
||||||
|
return attributes;
|
||||||
|
}
|
||||||
|
|
||||||
|
focusNext() {
|
||||||
|
const focusableElements = Array.from(this.getFocusableElements());
|
||||||
|
const activeIndex = focusableElements.indexOf(document.activeElement);
|
||||||
|
const nextIndex = (activeIndex + 1) % focusableElements.length;
|
||||||
|
focusableElements[nextIndex].focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
focusPrevious() {
|
||||||
|
const focusableElements = Array.from(this.getFocusableElements());
|
||||||
|
const activeIndex = focusableElements.indexOf(document.activeElement);
|
||||||
|
const previousIndex = (activeIndex || focusableElements.length) - 1;
|
||||||
|
focusableElements[previousIndex].focus();
|
||||||
|
}
|
||||||
|
|
||||||
|
open() {
|
||||||
|
if (this.props.onOpen) this.props.onOpen();
|
||||||
|
this.setState({ expanded: true });
|
||||||
|
// Listen to touchend and click events to ensure the menu
|
||||||
|
// can be closed on mobile, pointer, and mixed input devices
|
||||||
|
document.addEventListener('touchend', this.onDocumentClick, true);
|
||||||
|
document.addEventListener('click', this.onDocumentClick, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
close() {
|
||||||
|
if (this.props.onClose) this.props.onClose();
|
||||||
|
this.setState({ expanded: false });
|
||||||
|
document.removeEventListener('touchend', this.onDocumentClick, true);
|
||||||
|
document.removeEventListener('click', this.onDocumentClick, true);
|
||||||
|
}
|
||||||
|
|
||||||
|
toggle() {
|
||||||
|
if (this.state.expanded) {
|
||||||
|
this.close();
|
||||||
|
} else {
|
||||||
|
this.open();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
renderTrigger(node) {
|
||||||
|
return React.cloneElement(node, {
|
||||||
|
onClick: this.onTriggerClick,
|
||||||
|
'aria-haspopup': 'menu',
|
||||||
|
'aria-expanded': this.state.expanded,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
renderMenuContent(node) {
|
||||||
|
return (
|
||||||
|
<CSSTransition
|
||||||
|
in={this.state.expanded}
|
||||||
|
timeout={this.props.transitionTimeout}
|
||||||
|
classNames={this.props.transitionClassName}
|
||||||
|
unmountOnExit
|
||||||
|
>
|
||||||
|
{node}
|
||||||
|
</CSSTransition>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
const { className } = this.props;
|
||||||
|
|
||||||
|
const wrappedChildren = React.Children.map(this.props.children, (child) => {
|
||||||
|
if (child.type === MenuTriggerType) {
|
||||||
|
return this.renderTrigger(child);
|
||||||
|
}
|
||||||
|
return this.renderMenuContent(child);
|
||||||
|
});
|
||||||
|
|
||||||
|
const rootClassName = this.state.expanded ? 'menu expanded' : 'menu';
|
||||||
|
|
||||||
|
return React.createElement(this.props.tag, {
|
||||||
|
className: `${rootClassName} ${className}`,
|
||||||
|
ref: this.menu,
|
||||||
|
onKeyDown: this.onKeyDown,
|
||||||
|
onMouseEnter: this.onMouseEnter,
|
||||||
|
onMouseLeave: this.onMouseLeave,
|
||||||
|
...this.getAttributesFromProps(),
|
||||||
|
}, wrappedChildren);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
Menu.propTypes = {
|
||||||
|
tag: PropTypes.string,
|
||||||
|
onClose: PropTypes.func,
|
||||||
|
onOpen: PropTypes.func,
|
||||||
|
closeOnDocumentClick: PropTypes.bool,
|
||||||
|
respondToPointerEvents: PropTypes.bool,
|
||||||
|
className: PropTypes.string,
|
||||||
|
transitionTimeout: PropTypes.number,
|
||||||
|
transitionClassName: PropTypes.string,
|
||||||
|
children: PropTypes.arrayOf(PropTypes.node).isRequired,
|
||||||
|
};
|
||||||
|
Menu.defaultProps = {
|
||||||
|
tag: 'div',
|
||||||
|
className: null,
|
||||||
|
onClose: null,
|
||||||
|
onOpen: null,
|
||||||
|
respondToPointerEvents: false,
|
||||||
|
closeOnDocumentClick: true,
|
||||||
|
transitionTimeout: 250,
|
||||||
|
transitionClassName: 'menu-content',
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
export { Menu, MenuTrigger, MenuContent };
|
||||||
3
src/Menu/index.jsx
Normal file
3
src/Menu/index.jsx
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
import { Menu, MenuTrigger, MenuContent } from './Menu';
|
||||||
|
|
||||||
|
export { Menu, MenuTrigger, MenuContent };
|
||||||
45
src/Menu/menu.scss
Normal file
45
src/Menu/menu.scss
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
.menu {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
.menu-content {
|
||||||
|
position: absolute;
|
||||||
|
top: 100%;
|
||||||
|
z-index: 10;
|
||||||
|
background: #fff;
|
||||||
|
min-width: 10rem;
|
||||||
|
&.pin-left {
|
||||||
|
left: 0;
|
||||||
|
}
|
||||||
|
&.pin-right {
|
||||||
|
right: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
.menu-dropdown-enter {
|
||||||
|
opacity: 0;
|
||||||
|
transform-origin: 75% 0;
|
||||||
|
transform: scale3d(0.8, 0.8, 1);
|
||||||
|
}
|
||||||
|
.menu-dropdown-enter-active {
|
||||||
|
transform-origin: 75% 0;
|
||||||
|
transition: all 250ms cubic-bezier(0.4, 0, 0.2, 1);
|
||||||
|
transform: scale3d(1, 1, 1);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
.menu-dropdown-enter-done {
|
||||||
|
}
|
||||||
|
|
||||||
|
.menu-dropdown-exit {
|
||||||
|
transform-origin: 75% 0;
|
||||||
|
transform: scale3d(1, 1, 1);
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
.menu-dropdown-exit-active {
|
||||||
|
transform-origin: 75% 0;
|
||||||
|
transform: scale3d(0.8, 0.8, 1);
|
||||||
|
transition: all 250ms cubic-bezier(0.8, 0, 0.6, 1);
|
||||||
|
opacity: 0;
|
||||||
|
}
|
||||||
|
.menu-dropdown-exit-done {
|
||||||
|
}
|
||||||
186
src/MobileHeader.jsx
Normal file
186
src/MobileHeader.jsx
Normal file
@@ -0,0 +1,186 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import PropTypes from 'prop-types';
|
||||||
|
import { injectIntl, intlShape } from '@edx/frontend-i18n';
|
||||||
|
|
||||||
|
// Local Components
|
||||||
|
import { Menu, MenuTrigger, MenuContent } from './Menu';
|
||||||
|
import Avatar from './Avatar';
|
||||||
|
import { LinkedLogo, Logo } from './Logo';
|
||||||
|
|
||||||
|
// i18n
|
||||||
|
import messages from './SiteHeader.messages';
|
||||||
|
|
||||||
|
// Assets
|
||||||
|
import { MenuIcon } from './Icons';
|
||||||
|
|
||||||
|
class MobileHeader extends React.Component {
|
||||||
|
constructor(props) { // eslint-disable-line no-useless-constructor
|
||||||
|
super(props);
|
||||||
|
}
|
||||||
|
|
||||||
|
renderMainMenu() {
|
||||||
|
const { mainMenu } = this.props;
|
||||||
|
|
||||||
|
// Nodes are accepted as a prop
|
||||||
|
if (!Array.isArray(mainMenu)) return mainMenu;
|
||||||
|
|
||||||
|
return mainMenu.map((menuItem) => {
|
||||||
|
const {
|
||||||
|
type,
|
||||||
|
href,
|
||||||
|
content,
|
||||||
|
submenuContent,
|
||||||
|
} = menuItem;
|
||||||
|
|
||||||
|
if (type === 'item') {
|
||||||
|
return (
|
||||||
|
<a key={`${type}-${content}`} className="nav-link" href={href}>
|
||||||
|
{content}
|
||||||
|
</a>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Menu key={`${type}-${content}`} tag="div" className="nav-item">
|
||||||
|
<MenuTrigger tag="a" role="button" tabIndex="0" className="nav-link">
|
||||||
|
{content}
|
||||||
|
</MenuTrigger>
|
||||||
|
<MenuContent className="position-static pin-left pin-right py-2">
|
||||||
|
{submenuContent}
|
||||||
|
</MenuContent>
|
||||||
|
</Menu>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
renderUserMenuItems() {
|
||||||
|
const { userMenu } = this.props;
|
||||||
|
|
||||||
|
return userMenu.map(({ type, href, content }) => (
|
||||||
|
<li className="nav-item" key={`${type}-${content}`}>
|
||||||
|
<a className="nav-link" href={href}>{content}</a>
|
||||||
|
</li>
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
renderLoggedOutItems() {
|
||||||
|
const { loggedOutItems } = this.props;
|
||||||
|
|
||||||
|
return loggedOutItems.map(({ type, href, content }, i, arr) => (
|
||||||
|
<li className="nav-item px-3 my-2" key={`${type}-${content}`}>
|
||||||
|
<a
|
||||||
|
className={i < arr.length - 1 ? 'btn btn-block btn-outline-primary' : 'btn btn-block btn-primary'}
|
||||||
|
href={href}
|
||||||
|
>
|
||||||
|
{content}
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
const {
|
||||||
|
logo,
|
||||||
|
logoAltText,
|
||||||
|
logoDestination,
|
||||||
|
loggedIn,
|
||||||
|
avatar,
|
||||||
|
username,
|
||||||
|
stickyOnMobile,
|
||||||
|
intl,
|
||||||
|
mainMenu,
|
||||||
|
} = this.props;
|
||||||
|
const logoProps = { src: logo, alt: logoAltText, href: logoDestination };
|
||||||
|
const stickyClassName = stickyOnMobile ? 'sticky-top' : '';
|
||||||
|
|
||||||
|
return (
|
||||||
|
<header
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.main.header'])}
|
||||||
|
className={`site-header-mobile d-flex justify-content-between align-items-center shadow ${stickyClassName}`}
|
||||||
|
>
|
||||||
|
<div className="w-100 d-flex justify-content-start">
|
||||||
|
{mainMenu.length > 0 ?
|
||||||
|
<Menu className="position-static">
|
||||||
|
<MenuTrigger
|
||||||
|
tag="button"
|
||||||
|
className="icon-button"
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.main.menu'])}
|
||||||
|
title={intl.formatMessage(messages['header.label.main.menu'])}
|
||||||
|
>
|
||||||
|
<MenuIcon role="img" aria-hidden focusable="false" style={{ width: '1.5rem', height: '1.5rem' }} />
|
||||||
|
</MenuTrigger>
|
||||||
|
<MenuContent
|
||||||
|
tag="nav"
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.main.nav'])}
|
||||||
|
className="nav flex-column pin-left pin-right border-top shadow py-2"
|
||||||
|
>
|
||||||
|
{this.renderMainMenu()}
|
||||||
|
</MenuContent>
|
||||||
|
</Menu> : null }
|
||||||
|
</div>
|
||||||
|
<div className="w-100 d-flex justify-content-center">
|
||||||
|
{ logoDestination === null ? <Logo className="logo" src={logo} alt={logoAltText} /> : <LinkedLogo className="logo" {...logoProps} itemType="http://schema.org/Organization" />}
|
||||||
|
</div>
|
||||||
|
<div className="w-100 d-flex justify-content-end align-items-center">
|
||||||
|
<Menu tag="nav" aria-label={intl.formatMessage(messages['header.label.secondary.nav'])} className="position-static">
|
||||||
|
<MenuTrigger
|
||||||
|
tag="button"
|
||||||
|
className="icon-button"
|
||||||
|
aria-label={intl.formatMessage(messages['header.label.account.menu'])}
|
||||||
|
title={intl.formatMessage(messages['header.label.account.menu'])}
|
||||||
|
>
|
||||||
|
<Avatar size="1.5rem" src={avatar} alt={username} />
|
||||||
|
</MenuTrigger>
|
||||||
|
<MenuContent tag="ul" className="nav flex-column pin-left pin-right border-top shadow py-2">
|
||||||
|
{loggedIn ? this.renderUserMenuItems() : this.renderLoggedOutItems()}
|
||||||
|
</MenuContent>
|
||||||
|
</Menu>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
MobileHeader.propTypes = {
|
||||||
|
mainMenu: PropTypes.oneOfType([
|
||||||
|
PropTypes.node,
|
||||||
|
PropTypes.array,
|
||||||
|
]),
|
||||||
|
|
||||||
|
userMenu: PropTypes.arrayOf(PropTypes.shape({
|
||||||
|
type: PropTypes.oneOf(['item', 'menu']),
|
||||||
|
href: PropTypes.string,
|
||||||
|
content: PropTypes.string,
|
||||||
|
})),
|
||||||
|
loggedOutItems: PropTypes.arrayOf(PropTypes.shape({
|
||||||
|
type: PropTypes.oneOf(['item', 'menu']),
|
||||||
|
href: PropTypes.string,
|
||||||
|
content: PropTypes.string,
|
||||||
|
})),
|
||||||
|
logo: PropTypes.string,
|
||||||
|
logoAltText: PropTypes.string,
|
||||||
|
logoDestination: PropTypes.string,
|
||||||
|
avatar: PropTypes.string,
|
||||||
|
username: PropTypes.string,
|
||||||
|
loggedIn: PropTypes.bool,
|
||||||
|
stickyOnMobile: PropTypes.bool,
|
||||||
|
|
||||||
|
// i18n
|
||||||
|
intl: intlShape.isRequired,
|
||||||
|
};
|
||||||
|
|
||||||
|
MobileHeader.defaultProps = {
|
||||||
|
mainMenu: [],
|
||||||
|
userMenu: [],
|
||||||
|
loggedOutItems: [],
|
||||||
|
logo: null,
|
||||||
|
logoAltText: null,
|
||||||
|
logoDestination: null,
|
||||||
|
avatar: null,
|
||||||
|
username: null,
|
||||||
|
loggedIn: false,
|
||||||
|
stickyOnMobile: true,
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
export default injectIntl(MobileHeader);
|
||||||
103
src/SiteHeader.jsx
Normal file
103
src/SiteHeader.jsx
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
import React, { useContext } from 'react';
|
||||||
|
import Responsive from 'react-responsive';
|
||||||
|
import { injectIntl, intlShape } from '@edx/frontend-i18n';
|
||||||
|
import { App, AuthenticationContext } from '@edx/frontend-base';
|
||||||
|
|
||||||
|
import DesktopHeader from './DesktopHeader';
|
||||||
|
import MobileHeader from './MobileHeader';
|
||||||
|
|
||||||
|
import LogoSVG from './logo.svg';
|
||||||
|
|
||||||
|
import messages from './SiteHeader.messages';
|
||||||
|
|
||||||
|
App.requireConfig([
|
||||||
|
'LMS_BASE_URL',
|
||||||
|
'LOGOUT_URL',
|
||||||
|
'LOGIN_URL',
|
||||||
|
'SITE_NAME',
|
||||||
|
], 'Header component');
|
||||||
|
|
||||||
|
const {
|
||||||
|
LMS_BASE_URL,
|
||||||
|
LOGOUT_URL,
|
||||||
|
LOGIN_URL,
|
||||||
|
SITE_NAME,
|
||||||
|
} = App.config;
|
||||||
|
|
||||||
|
function SiteHeader({ intl }) {
|
||||||
|
const { username, avatar } = useContext(AuthenticationContext);
|
||||||
|
|
||||||
|
const mainMenu = [
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: `${LMS_BASE_URL}/dashboard`,
|
||||||
|
content: intl.formatMessage(messages['header.links.courses']),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const userMenu = [
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: `${LMS_BASE_URL}/dashboard`,
|
||||||
|
content: intl.formatMessage(messages['header.user.menu.dashboard']),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: `${LMS_BASE_URL}/u/${username}`,
|
||||||
|
content: intl.formatMessage(messages['header.user.menu.profile']),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: `${LMS_BASE_URL}/account/settings`,
|
||||||
|
content: intl.formatMessage(messages['header.user.menu.account.settings']),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: LOGOUT_URL,
|
||||||
|
content: intl.formatMessage(messages['header.user.menu.logout']),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const loggedOutItems = [
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: LOGIN_URL,
|
||||||
|
content: intl.formatMessage(messages['header.user.menu.login']),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'item',
|
||||||
|
href: `${LMS_BASE_URL}/register`,
|
||||||
|
content: intl.formatMessage(messages['header.user.menu.register']),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
const props = {
|
||||||
|
logo: LogoSVG,
|
||||||
|
logoAltText: SITE_NAME,
|
||||||
|
siteName: SITE_NAME,
|
||||||
|
logoDestination: `${LMS_BASE_URL}/dashboard`,
|
||||||
|
loggedIn: !!username,
|
||||||
|
username,
|
||||||
|
avatar,
|
||||||
|
mainMenu,
|
||||||
|
userMenu,
|
||||||
|
loggedOutItems,
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<React.Fragment>
|
||||||
|
<Responsive maxWidth={768}>
|
||||||
|
<MobileHeader {...props} />
|
||||||
|
</Responsive>
|
||||||
|
<Responsive minWidth={769}>
|
||||||
|
<DesktopHeader {...props} />
|
||||||
|
</Responsive>
|
||||||
|
</React.Fragment>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
SiteHeader.propTypes = {
|
||||||
|
intl: intlShape.isRequired,
|
||||||
|
};
|
||||||
|
|
||||||
|
export default injectIntl(SiteHeader);
|
||||||
96
src/SiteHeader.messages.jsx
Normal file
96
src/SiteHeader.messages.jsx
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
import { defineMessages } from '@edx/frontend-i18n';
|
||||||
|
|
||||||
|
const messages = defineMessages({
|
||||||
|
'header.links.courses': {
|
||||||
|
id: 'header.links.courses',
|
||||||
|
defaultMessage: 'Courses',
|
||||||
|
description: 'Link to the learner course dashboard',
|
||||||
|
},
|
||||||
|
'header.links.programs': {
|
||||||
|
id: 'header.links.programs',
|
||||||
|
defaultMessage: 'Programs',
|
||||||
|
description: 'Link to the learner program dashboard',
|
||||||
|
},
|
||||||
|
'header.links.content.search': {
|
||||||
|
id: 'header.links.content.search',
|
||||||
|
defaultMessage: 'Discover New',
|
||||||
|
description: 'Link to the content search page',
|
||||||
|
},
|
||||||
|
'header.links.schools': {
|
||||||
|
id: 'header.links.schools',
|
||||||
|
defaultMessage: 'Schools & Partners',
|
||||||
|
description: 'Link to the schools and partners landing page',
|
||||||
|
},
|
||||||
|
'header.user.menu.dashboard': {
|
||||||
|
id: 'header.user.menu.dashboard',
|
||||||
|
defaultMessage: 'Dashboard',
|
||||||
|
description: 'Link to the user dashboard',
|
||||||
|
},
|
||||||
|
'header.user.menu.profile': {
|
||||||
|
id: 'header.user.menu.profile',
|
||||||
|
defaultMessage: 'Profile',
|
||||||
|
description: 'Link to the user profile',
|
||||||
|
},
|
||||||
|
'header.user.menu.account.settings': {
|
||||||
|
id: 'header.user.menu.account.settings',
|
||||||
|
defaultMessage: 'Account',
|
||||||
|
description: 'Link to account settings',
|
||||||
|
},
|
||||||
|
'header.user.menu.order.history': {
|
||||||
|
id: 'header.user.menu.order.history',
|
||||||
|
defaultMessage: 'Order History',
|
||||||
|
description: 'Link to order history',
|
||||||
|
},
|
||||||
|
'header.user.menu.logout': {
|
||||||
|
id: 'header.user.menu.logout',
|
||||||
|
defaultMessage: 'Logout',
|
||||||
|
description: 'Logout link',
|
||||||
|
},
|
||||||
|
'header.user.menu.login': {
|
||||||
|
id: 'header.user.menu.login',
|
||||||
|
defaultMessage: 'Login',
|
||||||
|
description: 'Login link',
|
||||||
|
},
|
||||||
|
'header.user.menu.register': {
|
||||||
|
id: 'header.user.menu.register',
|
||||||
|
defaultMessage: 'Sign Up',
|
||||||
|
description: 'Link to registration',
|
||||||
|
},
|
||||||
|
'header.label.account.nav': {
|
||||||
|
id: 'header.label.account.nav',
|
||||||
|
defaultMessage: 'Account',
|
||||||
|
description: 'The aria label for the account menu nav',
|
||||||
|
},
|
||||||
|
'header.label.account.menu': {
|
||||||
|
id: 'header.label.account.menu',
|
||||||
|
defaultMessage: 'Account Menu',
|
||||||
|
description: 'The aria label for the account menu trigger',
|
||||||
|
},
|
||||||
|
'header.label.account.menu.for': {
|
||||||
|
id: 'header.label.account.menu',
|
||||||
|
defaultMessage: 'Account menu for {username}',
|
||||||
|
description: 'The aria label for the account menu trigger when the username is displayed in it',
|
||||||
|
},
|
||||||
|
'header.label.main.nav': {
|
||||||
|
id: 'header.label.main.nav',
|
||||||
|
defaultMessage: 'Main',
|
||||||
|
description: 'The aria label for the main menu nav',
|
||||||
|
},
|
||||||
|
'header.label.main.menu': {
|
||||||
|
id: 'header.label.main.menu',
|
||||||
|
defaultMessage: 'Main Menu',
|
||||||
|
description: 'The aria label for the main menu trigger',
|
||||||
|
},
|
||||||
|
'header.label.main.header': {
|
||||||
|
id: 'header.label.main.header',
|
||||||
|
defaultMessage: 'Main',
|
||||||
|
description: 'The aria label for the main header',
|
||||||
|
},
|
||||||
|
'header.label.secondary.nav': {
|
||||||
|
id: 'header.label.secondary.nav',
|
||||||
|
defaultMessage: 'Secondary',
|
||||||
|
description: 'The aria label for the seconary nav',
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
export default messages;
|
||||||
54
src/SiteHeader.test.jsx
Normal file
54
src/SiteHeader.test.jsx
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
|
||||||
|
import React from 'react';
|
||||||
|
import { IntlProvider } from '@edx/frontend-i18n';
|
||||||
|
import TestRenderer from 'react-test-renderer';
|
||||||
|
import { AuthenticationContext } from '@edx/frontend-base';
|
||||||
|
import { Context as ResponsiveContext } from 'react-responsive';
|
||||||
|
|
||||||
|
import SiteHeader from './index';
|
||||||
|
|
||||||
|
describe('<SiteHeader />', () => {
|
||||||
|
it('renders correctly for desktop', () => {
|
||||||
|
const component = (
|
||||||
|
<ResponsiveContext.Provider value={{ width: 1280 }}>
|
||||||
|
<IntlProvider locale="en" messages={{}}>
|
||||||
|
<AuthenticationContext.Provider
|
||||||
|
value={{
|
||||||
|
userId: null,
|
||||||
|
username: null,
|
||||||
|
administrator: false,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<SiteHeader />
|
||||||
|
</AuthenticationContext.Provider>
|
||||||
|
</IntlProvider>
|
||||||
|
</ResponsiveContext.Provider>
|
||||||
|
);
|
||||||
|
|
||||||
|
const wrapper = TestRenderer.create(component);
|
||||||
|
|
||||||
|
expect(wrapper.toJSON()).toMatchSnapshot();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('renders correctly for mobile', () => {
|
||||||
|
const component = (
|
||||||
|
<ResponsiveContext.Provider value={{ width: 500 }}>
|
||||||
|
<IntlProvider locale="en" messages={{}}>
|
||||||
|
<AuthenticationContext.Provider
|
||||||
|
value={{
|
||||||
|
userId: null,
|
||||||
|
username: null,
|
||||||
|
administrator: false,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<SiteHeader />
|
||||||
|
</AuthenticationContext.Provider>
|
||||||
|
</IntlProvider>
|
||||||
|
</ResponsiveContext.Provider>
|
||||||
|
);
|
||||||
|
|
||||||
|
const wrapper = TestRenderer.create(component);
|
||||||
|
|
||||||
|
expect(wrapper.toJSON()).toMatchSnapshot();
|
||||||
|
});
|
||||||
|
});
|
||||||
3
src/__mocks__/fileMock.js
Normal file
3
src/__mocks__/fileMock.js
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
// __mocks__/fileMock.js
|
||||||
|
|
||||||
|
module.exports = 'test-file-stub';
|
||||||
186
src/__snapshots__/SiteHeader.test.jsx.snap
Normal file
186
src/__snapshots__/SiteHeader.test.jsx.snap
Normal file
@@ -0,0 +1,186 @@
|
|||||||
|
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||||
|
|
||||||
|
exports[`<SiteHeader /> renders correctly for desktop 1`] = `
|
||||||
|
<header
|
||||||
|
className="site-header-desktop"
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
className="container-fluid"
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
className="nav-container position-relative d-flex align-items-center"
|
||||||
|
>
|
||||||
|
<a
|
||||||
|
className="logo"
|
||||||
|
href="http://localhost:18000/dashboard"
|
||||||
|
>
|
||||||
|
<img
|
||||||
|
alt="edX"
|
||||||
|
className="d-block"
|
||||||
|
src="test-file-stub"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
<nav
|
||||||
|
aria-label="Main"
|
||||||
|
className="nav main-nav"
|
||||||
|
>
|
||||||
|
<a
|
||||||
|
className="nav-link"
|
||||||
|
href="http://localhost:18000/dashboard"
|
||||||
|
>
|
||||||
|
Courses
|
||||||
|
</a>
|
||||||
|
</nav>
|
||||||
|
<nav
|
||||||
|
aria-label="Secondary"
|
||||||
|
className="nav secondary-menu-container align-items-center ml-auto"
|
||||||
|
>
|
||||||
|
<a
|
||||||
|
className="btn mr-2 btn-link"
|
||||||
|
href="http://localhost:18000/login"
|
||||||
|
>
|
||||||
|
Login
|
||||||
|
</a>
|
||||||
|
<a
|
||||||
|
className="btn mr-2 btn-outline-primary"
|
||||||
|
href="http://localhost:18000/register"
|
||||||
|
>
|
||||||
|
Sign Up
|
||||||
|
</a>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
`;
|
||||||
|
|
||||||
|
exports[`<SiteHeader /> renders correctly for mobile 1`] = `
|
||||||
|
<header
|
||||||
|
aria-label="Main"
|
||||||
|
className="site-header-mobile d-flex justify-content-between align-items-center shadow sticky-top"
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
className="w-100 d-flex justify-content-start"
|
||||||
|
>
|
||||||
|
<div
|
||||||
|
className="menu position-static"
|
||||||
|
onKeyDown={[Function]}
|
||||||
|
onMouseEnter={[Function]}
|
||||||
|
onMouseLeave={[Function]}
|
||||||
|
>
|
||||||
|
<button
|
||||||
|
aria-expanded={false}
|
||||||
|
aria-haspopup="menu"
|
||||||
|
aria-label="Main Menu"
|
||||||
|
className="menu-trigger icon-button"
|
||||||
|
onClick={[Function]}
|
||||||
|
title="Main Menu"
|
||||||
|
>
|
||||||
|
<svg
|
||||||
|
aria-hidden={true}
|
||||||
|
focusable="false"
|
||||||
|
height="24px"
|
||||||
|
role="img"
|
||||||
|
style={
|
||||||
|
Object {
|
||||||
|
"height": "1.5rem",
|
||||||
|
"width": "1.5rem",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
version="1.1"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
width="24px"
|
||||||
|
>
|
||||||
|
<rect
|
||||||
|
fill="currentColor"
|
||||||
|
height="2"
|
||||||
|
width="20"
|
||||||
|
x="2"
|
||||||
|
y="5"
|
||||||
|
/>
|
||||||
|
<rect
|
||||||
|
fill="currentColor"
|
||||||
|
height="2"
|
||||||
|
width="20"
|
||||||
|
x="2"
|
||||||
|
y="11"
|
||||||
|
/>
|
||||||
|
<rect
|
||||||
|
fill="currentColor"
|
||||||
|
height="2"
|
||||||
|
width="20"
|
||||||
|
x="2"
|
||||||
|
y="17"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
className="w-100 d-flex justify-content-center"
|
||||||
|
>
|
||||||
|
<a
|
||||||
|
className="logo"
|
||||||
|
href="http://localhost:18000/dashboard"
|
||||||
|
itemType="http://schema.org/Organization"
|
||||||
|
>
|
||||||
|
<img
|
||||||
|
alt="edX"
|
||||||
|
className="d-block"
|
||||||
|
src="test-file-stub"
|
||||||
|
/>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
<div
|
||||||
|
className="w-100 d-flex justify-content-end align-items-center"
|
||||||
|
>
|
||||||
|
<nav
|
||||||
|
aria-label="Secondary"
|
||||||
|
className="menu position-static"
|
||||||
|
onKeyDown={[Function]}
|
||||||
|
onMouseEnter={[Function]}
|
||||||
|
onMouseLeave={[Function]}
|
||||||
|
>
|
||||||
|
<button
|
||||||
|
aria-expanded={false}
|
||||||
|
aria-haspopup="menu"
|
||||||
|
aria-label="Account Menu"
|
||||||
|
className="menu-trigger icon-button"
|
||||||
|
onClick={[Function]}
|
||||||
|
title="Account Menu"
|
||||||
|
>
|
||||||
|
<span
|
||||||
|
className="avatar overflow-hidden d-inline-flex rounded-circle null"
|
||||||
|
style={
|
||||||
|
Object {
|
||||||
|
"height": "1.5rem",
|
||||||
|
"width": "1.5rem",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<svg
|
||||||
|
aria-hidden={true}
|
||||||
|
className="text-muted"
|
||||||
|
focusable="false"
|
||||||
|
height="24px"
|
||||||
|
role="img"
|
||||||
|
style={
|
||||||
|
Object {
|
||||||
|
"height": "1.5rem",
|
||||||
|
"width": "1.5rem",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
version="1.1"
|
||||||
|
viewBox="0 0 24 24"
|
||||||
|
width="24px"
|
||||||
|
>
|
||||||
|
<path
|
||||||
|
d="M4.10255106,18.1351061 C4.7170266,16.0581859 8.01891846,14.4720277 12,14.4720277 C15.9810815,14.4720277 19.2829734,16.0581859 19.8974489,18.1351061 C21.215206,16.4412566 22,14.3122775 22,12 C22,6.4771525 17.5228475,2 12,2 C6.4771525,2 2,6.4771525 2,12 C2,14.3122775 2.78479405,16.4412566 4.10255106,18.1351061 Z M12,24 C5.372583,24 0,18.627417 0,12 C0,5.372583 5.372583,0 12,0 C18.627417,0 24,5.372583 24,12 C24,18.627417 18.627417,24 12,24 Z M12,13 C9.790861,13 8,11.209139 8,9 C8,6.790861 9.790861,5 12,5 C14.209139,5 16,6.790861 16,9 C16,11.209139 14.209139,13 12,13 Z"
|
||||||
|
fill="currentColor"
|
||||||
|
/>
|
||||||
|
</svg>
|
||||||
|
</span>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
`;
|
||||||
6
src/index.jsx
Normal file
6
src/index.jsx
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import SiteHeader from './SiteHeader';
|
||||||
|
import messages from './SiteHeader.messages';
|
||||||
|
|
||||||
|
export { messages };
|
||||||
|
|
||||||
|
export default SiteHeader;
|
||||||
95
src/index.scss
Normal file
95
src/index.scss
Normal file
@@ -0,0 +1,95 @@
|
|||||||
|
$spacer: 1rem;
|
||||||
|
$blue: #007db8;
|
||||||
|
$white: #fff;
|
||||||
|
|
||||||
|
@import './Menu/menu.scss';
|
||||||
|
|
||||||
|
.dropdown-item a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon-button {
|
||||||
|
display: inline-flex;
|
||||||
|
line-height: 3rem;
|
||||||
|
background: transparent;
|
||||||
|
vertical-align: middle;
|
||||||
|
text-align: center;
|
||||||
|
border: none;
|
||||||
|
height: 3rem;
|
||||||
|
width: 3rem;
|
||||||
|
padding: .75rem;
|
||||||
|
justify-content: center;
|
||||||
|
align-items:center;
|
||||||
|
&:hover, &:focus {
|
||||||
|
background: rgba(0,0,0,.1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-header-mobile,
|
||||||
|
.site-header-desktop {
|
||||||
|
position: relative;
|
||||||
|
z-index: 1000;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-header-mobile {
|
||||||
|
.nav-link {
|
||||||
|
text-decoration: none;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
img {
|
||||||
|
height: 1.5rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
.site-header-desktop {
|
||||||
|
height: 3.75rem;
|
||||||
|
box-shadow: 0 1px 0 0 rgba(0,0,0,.1);
|
||||||
|
background: $white;
|
||||||
|
.nav-link {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.logo {
|
||||||
|
display: block;
|
||||||
|
box-sizing: content-box;
|
||||||
|
position: relative;
|
||||||
|
top: -.05em;
|
||||||
|
height: 1.75rem;
|
||||||
|
padding: 1rem 0;
|
||||||
|
margin-right: 1rem;
|
||||||
|
img {
|
||||||
|
display: block;
|
||||||
|
height: 100%;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.main-nav {
|
||||||
|
.nav-link {
|
||||||
|
padding: 1.125rem 1rem;
|
||||||
|
text-decoration: none;
|
||||||
|
font-weight: 500;
|
||||||
|
letter-spacing: .01em;
|
||||||
|
}
|
||||||
|
.nav-link:hover,
|
||||||
|
.nav-link:focus,
|
||||||
|
.nav-link.active,
|
||||||
|
.expanded .nav-link {
|
||||||
|
background: $component-active-bg;
|
||||||
|
color: $component-active-color;
|
||||||
|
}
|
||||||
|
.menu {
|
||||||
|
position: static;
|
||||||
|
.menu-content {
|
||||||
|
border-top: solid 2px $component-active-bg;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
box-shadow: 0 1px 2px rgba(0,0,0,.25);
|
||||||
|
border-bottom-left-radius: 2px;
|
||||||
|
border-bottom-right-radius: 2px;
|
||||||
|
padding: 1rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.search-input {
|
||||||
|
border-radius: $rounded-pill;
|
||||||
|
}
|
||||||
|
}
|
||||||
1
src/logo.svg
Normal file
1
src/logo.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 17 KiB |
Reference in New Issue
Block a user