From 4d13049e39299359e81f5a9795832ac2f3ba1f0e Mon Sep 17 00:00:00 2001 From: Josh Roach Date: Wed, 25 Jul 2018 13:35:11 -0400 Subject: [PATCH 01/16] Add all base repo files via the d2l-hybrid-element Polymer generator --- README.md | 93 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 92 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 57e525b4..367efb97 100644 --- a/README.md +++ b/README.md @@ -1 +1,92 @@ -# navigation \ No newline at end of file +# navigation +[![Bower version][bower-image]][bower-url] +[![Build status][ci-image]][ci-url] + +Parent repo for all navigation based web components + +## d2l-navigation-band +[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/BrightspaceUI/d2l-navigation-band) + +Solid colour band that runs along the top of the navigational header + +### Installation + +`d2l-navigation-band` can be installed from [Bower][bower-url]: +```shell +bower install d2l-navigation-band +``` + +### Usage + +Include the [webcomponents.js](http://webcomponents.org/polyfills/) "lite" polyfill (for browsers who don't natively support web components), then import `d2l-navigation-band.html`: + +```html + + + + +``` + + +```html +My element +``` + +## Developing, Testing and Contributing + +After cloning the repo, run `npm install` to install dependencies. + +If you don't have it already, install the [Polymer CLI](https://www.polymer-project.org/3.0/docs/tools/polymer-cli) globally: + +```shell +npm install -g polymer-cli +``` + +To start a [local web server](https://www.polymer-project.org/3.0/docs/tools/polymer-cli-commands#serve) that hosts the demo page and tests: + +```shell +polymer serve +``` + +To lint ([eslint](http://eslint.org/) and [Polymer lint](https://www.polymer-project.org/3.0/docs/tools/polymer-cli-commands#lint)): + +```shell +npm run lint +``` + +To run unit tests locally using [Polymer test](https://www.polymer-project.org/3.0/docs/tools/polymer-cli-commands#tests): + +```shell +npm run test:polymer:local +``` + +To lint AND run local unit tests: + +```shell +npm test +``` + +[bower-url]: http://bower.io/search/?q=navigation +[bower-image]: https://badge.fury.io/bo/navigation.svg +[ci-url]: https://travis-ci.org/BrightspaceUI/navigation +[ci-image]: https://travis-ci.org/BrightspaceUI/navigation.svg?branch=master From 67e09c5ec999958c535ee4fc54e94e03ba936cc5 Mon Sep 17 00:00:00 2001 From: Josh Roach Date: Wed, 25 Jul 2018 13:36:53 -0400 Subject: [PATCH 02/16] Actually add all base repo files via the d2l-hybrid-element Polymer generator --- .editorconfig | 13 ++ .eslintrc.json | 3 + .gitignore | 5 + .travis.yml | 17 +++ CODEOWNERS | 3 + LICENSE | 191 ++++++++++++++++++++++++ all-imports.html | 1 + bower.json | 41 +++++ demo/index.html | 34 +++++ index.html | 13 ++ package.json | 28 ++++ polymer.json | 7 + test/.eslintrc.json | 3 + test/index.html | 18 +++ test/navigation-band.html | 26 ++++ wct.conf.json | 39 +++++ web-components/d2l-navigation-band.html | 29 ++++ 17 files changed, 471 insertions(+) create mode 100644 .editorconfig create mode 100644 .eslintrc.json create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 CODEOWNERS create mode 100644 LICENSE create mode 100644 all-imports.html create mode 100644 bower.json create mode 100644 demo/index.html create mode 100644 index.html create mode 100644 package.json create mode 100644 polymer.json create mode 100644 test/.eslintrc.json create mode 100644 test/index.html create mode 100644 test/navigation-band.html create mode 100644 wct.conf.json create mode 100644 web-components/d2l-navigation-band.html diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..ad396cfc --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = tab +indent_size = 4 + +[{*.json,*.yml}] +indent_style = space +indent_size = 2 diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 00000000..d41a881b --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "brightspace/polymer-config" +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..13087739 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +bower_components +bower_components-1.x +bower-1.x.json +node_modules +package-lock.json diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..7404335f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,17 @@ +language: node_js +node_js: node +addons: + chrome: stable +script: +- npm run lint +- | + if [ $TRAVIS_PULL_REQUEST != false ] && [ $TRAVIS_SECURE_ENV_VARS == true ]; then + echo "Pull request with secure environment variables, running Sauce tests..."; + npm run test:polymer:sauce || travis_terminate 1; + else + echo "Not a pull request and/or no secure environment variables, running headless tests..."; + npm run test:polymer:local || travis_terminate 1; + fi +env: + global: + SAUCE_USERNAME: Desire2Learn diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..c1c9a8a9 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,3 @@ +* @jeroach +* @svanherk +* @CarolBusman diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..5a2cf622 --- /dev/null +++ b/LICENSE @@ -0,0 +1,191 @@ +Apache License +Version 2.0, January 2004 +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, "control" means (i) the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +"Object" form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +"submitted" means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +You must give any other recipients of the Work or Derivative Works a copy of +this License; and +You must cause any modified files to carry prominent notices stating that You +changed the files; and +You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +If the Work includes a "NOTICE" text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +8. Limitation of Liability. + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work + +To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets "[]" replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included on +the same "printed page" as the copyright notice for easier identification within +third-party archives. + + Copyright 2018 D2L Corporation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/all-imports.html b/all-imports.html new file mode 100644 index 00000000..f9b347e5 --- /dev/null +++ b/all-imports.html @@ -0,0 +1 @@ + diff --git a/bower.json b/bower.json new file mode 100644 index 00000000..c5767a5d --- /dev/null +++ b/bower.json @@ -0,0 +1,41 @@ +{ + "name": "navigation", + "description": "Parent repo for all navigation based web components", + "main": "index.html", + "license": "Apache-2.0", + "ignore": [ + "demo", + "test", + ".editorconfig", + ".eslintrc.json", + ".gitignore", + ".travis.yml", + "CODEOWNERS", + "package.json", + "polymer.json", + "wct.conf.json" + ], + "dependencies": { + "polymer": "Polymer/polymer#1 - 2" + }, + "devDependencies": { + "d2l-typography": "BrightspaceUI/typography#^6.0.0", + "iron-component-page": "PolymerElements/iron-component-page#^2.0.0", + "iron-demo-helpers": "PolymerElements/iron-demo-helpers#^2.0.0", + "iron-test-helpers": "PolymerElements/iron-test-helpers#^2.0.0", + "web-component-tester": "Polymer/web-component-tester#^6.0.0" + }, + "variants": { + "1.x": { + "dependencies": { + "polymer": "Polymer/polymer#^1.0.0" + }, + "resolutions": { + "webcomponentsjs": "^0.7" + } + } + }, + "resolutions": { + "webcomponentsjs": "^1.0.0" + } +} diff --git a/demo/index.html b/demo/index.html new file mode 100644 index 00000000..79a682a9 --- /dev/null +++ b/demo/index.html @@ -0,0 +1,34 @@ + + + + + + d2l-navigation-band demo + + + + + + + + + + + + + + +
+

d2l-navigation-band

+ + + +
+ + diff --git a/index.html b/index.html new file mode 100644 index 00000000..8e1fda32 --- /dev/null +++ b/index.html @@ -0,0 +1,13 @@ + + + + + + d2l-navigation-band + + + + + + + diff --git a/package.json b/package.json new file mode 100644 index 00000000..66b2900f --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "navigation", + "description": "Parent repo for all navigation based web components", + "private": true, + "scripts": { + "postinstall": "polymer install --variants", + "lint": "npm run lint:wc && npm run lint:html", + "lint:html": "eslint *.html demo/*.html test/*.html", + "lint:wc": "polymer lint -i d2l-navigation-band.html", + "test:polymer:local": "polymer test --skip-plugin sauce", + "test:polymer:sauce": "polymer test --skip-plugin local", + "test": "npm run lint && npm run test:polymer:local" + }, + "repository": { + "type": "git", + "url": "https://github.com/BrightspaceUI/navigation.git" + }, + "author": "D2L Corporation", + "license": "Apache-2.0", + "devDependencies": { + "chromedriver": "^2.40.0", + "eslint": "^4.19.1", + "eslint-config-brightspace": "^0.4.0", + "eslint-plugin-html": "^4.0.5", + "polymer-cli": "^1.7.4", + "sauce-connect-launcher": "^1.2.4" + } +} diff --git a/polymer.json b/polymer.json new file mode 100644 index 00000000..3d0892ee --- /dev/null +++ b/polymer.json @@ -0,0 +1,7 @@ +{ + "lint": { + "rules": [ + "polymer-2-hybrid" + ] + } +} diff --git a/test/.eslintrc.json b/test/.eslintrc.json new file mode 100644 index 00000000..699e853a --- /dev/null +++ b/test/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "brightspace/wct-config" +} diff --git a/test/index.html b/test/index.html new file mode 100644 index 00000000..d5572078 --- /dev/null +++ b/test/index.html @@ -0,0 +1,18 @@ + + + + + + d2l-navigation-band tests + + + + + + + diff --git a/test/navigation-band.html b/test/navigation-band.html new file mode 100644 index 00000000..9346f618 --- /dev/null +++ b/test/navigation-band.html @@ -0,0 +1,26 @@ + + + + + + d2l-navigation-band test + + + + + + + + + + + diff --git a/wct.conf.json b/wct.conf.json new file mode 100644 index 00000000..6ea17c49 --- /dev/null +++ b/wct.conf.json @@ -0,0 +1,39 @@ +{ + "plugins": { + "local": { + "browsers": ["chrome"], + "browserOptions": { + "chrome": ["headless", "disable-gpu", "no-sandbox"] + } + }, + "sauce": { + "browsers": [ + { + "browserName": "chrome", + "platform": "OS X 10.12", + "version": "" + }, + { + "browserName": "firefox", + "platform": "OS X 10.12", + "version": "" + }, + { + "browserName": "safari", + "platform": "OS X 10.12", + "version": "" + }, + { + "browserName": "microsoftedge", + "platform": "Windows 10", + "version": "" + }, + { + "browserName": "internet explorer", + "platform": "Windows 10", + "version": "11" + } + ] + } + } +} diff --git a/web-components/d2l-navigation-band.html b/web-components/d2l-navigation-band.html new file mode 100644 index 00000000..3010adad --- /dev/null +++ b/web-components/d2l-navigation-band.html @@ -0,0 +1,29 @@ + + + + + + + + From 992f89e514aefcfb52de814216ff50dbce5d762f Mon Sep 17 00:00:00 2001 From: Josh Roach Date: Wed, 25 Jul 2018 13:48:14 -0400 Subject: [PATCH 03/16] Minor tweaks --- CODEOWNERS | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CODEOWNERS b/CODEOWNERS index c1c9a8a9..2529493f 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,3 +1,3 @@ -* @jeroach +* @jeroach * @svanherk * @CarolBusman diff --git a/README.md b/README.md index 367efb97..79c171b6 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Include the [webcomponents.js](http://webcomponents.org/polyfills/) "lite" polyf ``` --> ```html -My element + ``` ## Developing, Testing and Contributing From f34c655f0ddf681b3c44cfa93e59bf069773c003 Mon Sep 17 00:00:00 2001 From: Josh Roach Date: Wed, 25 Jul 2018 14:01:01 -0400 Subject: [PATCH 04/16] Updating content of d2l-navigation-band --- web-components/d2l-navigation-band.html | 22 +++++----------------- 1 file changed, 5 insertions(+), 17 deletions(-) diff --git a/web-components/d2l-navigation-band.html b/web-components/d2l-navigation-band.html index 3010adad..988c38aa 100644 --- a/web-components/d2l-navigation-band.html +++ b/web-components/d2l-navigation-band.html @@ -1,29 +1,17 @@ - - - - From de940c53bb2e14d0a2b43f4478466f281526be85 Mon Sep 17 00:00:00 2001 From: Josh Roach Date: Wed, 25 Jul 2018 14:51:30 -0400 Subject: [PATCH 05/16] Add required imports --- web-components/d2l-navigation-band.html | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/web-components/d2l-navigation-band.html b/web-components/d2l-navigation-band.html index 988c38aa..4f992fe3 100644 --- a/web-components/d2l-navigation-band.html +++ b/web-components/d2l-navigation-band.html @@ -1,3 +1,13 @@ + + + + +