From e31cb2c2e459b3d02b232901acefcf68f898bb28 Mon Sep 17 00:00:00 2001 From: Github Pages Overwriter Date: Tue, 5 Dec 2023 11:47:18 +0000 Subject: [PATCH] Automated publish --- 3rdpartylicenses.txt | 312 ++++++++++++++ CHANGELOG.md | 130 ++++++ LICENSE | 21 + README.md | 407 ++++++++++++++++++ Roboto-Black.2eaa390d458c877d.woff2 | Bin 0 -> 64960 bytes Roboto-Black.b25f67ad8583da68.woff | Bin 0 -> 86508 bytes Roboto-BlackItalic.7dc03ee444552bc5.woff2 | Bin 0 -> 72088 bytes Roboto-BlackItalic.c8dc642467cb3099.woff | Bin 0 -> 94048 bytes Roboto-Bold.447291a88c067396.woff2 | Bin 0 -> 64740 bytes Roboto-Bold.fc482e6133cf5e26.woff | Bin 0 -> 86184 bytes Roboto-BoldItalic.1b15168ef6fa4e16.woff2 | Bin 0 -> 70360 bytes Roboto-BoldItalic.e26ba339b06f09f7.woff | Bin 0 -> 91968 bytes Roboto-Light.0e01b6cd13b3857f.woff2 | Bin 0 -> 64320 bytes Roboto-Light.603ca9a537b88428.woff | Bin 0 -> 85692 bytes Roboto-LightItalic.1b5e142f787151c8.woff | Bin 0 -> 92864 bytes Roboto-LightItalic.232ef4b20215f720.woff2 | Bin 0 -> 70760 bytes Roboto-Medium.457532032ceb0168.woff2 | Bin 0 -> 65484 bytes Roboto-Medium.6e1ae5f0b324a0aa.woff | Bin 0 -> 86444 bytes Roboto-MediumItalic.872f7060602d55d2.woff2 | Bin 0 -> 71284 bytes Roboto-MediumItalic.e06fb533801cbb08.woff | Bin 0 -> 93228 bytes Roboto-Regular.475ba9e4e2d63456.woff2 | Bin 0 -> 64632 bytes Roboto-Regular.bcefbfee882bc1cb.woff | Bin 0 -> 85876 bytes Roboto-RegularItalic.0668fae6af0cf8c2.woff | Bin 0 -> 91728 bytes Roboto-RegularItalic.e3a9ebdaac06bbc4.woff2 | Bin 0 -> 70280 bytes Roboto-Thin.c13c157cb81e8ebb.woff | Bin 0 -> 84224 bytes Roboto-Thin.f7a95c9c5999532c.woff2 | Bin 0 -> 63048 bytes Roboto-ThinItalic.1111028df6cea564.woff | Bin 0 -> 90784 bytes Roboto-ThinItalic.b0e084abf689f393.woff2 | Bin 0 -> 68328 bytes assets/minimalConfigDemo.jpg | Bin 0 -> 22381 bytes assets/screenshot.jpg | Bin 0 -> 129317 bytes favicon.ico | Bin 0 -> 5430 bytes index.html | 11 + main.986a45e093da463f.js | 1 + material-icons-outlined.78a93b2079680a08.woff | Bin 0 -> 182028 bytes ...rial-icons-outlined.f86cb7b0aa53f0fe.woff2 | Bin 0 -> 155276 bytes material-icons-round.92dc7ca2f4c591e7.woff | Bin 0 -> 206260 bytes material-icons-round.b10ec9db5b7fbc74.woff2 | Bin 0 -> 173620 bytes material-icons-sharp.3885863ee4746422.woff2 | Bin 0 -> 135984 bytes material-icons-sharp.a71cb2bf66c604de.woff | Bin 0 -> 156236 bytes material-icons-two-tone.588d63134de807a7.woff | Bin 0 -> 339600 bytes ...rial-icons-two-tone.675bd578bd14533e.woff2 | Bin 0 -> 215704 bytes material-icons.4ad034d2c499d9b6.woff | Bin 0 -> 164912 bytes material-icons.59322316b3fd6063.woff2 | Bin 0 -> 128352 bytes polyfills.fe77287e05f61a9e.js | 1 + publish_date.txt | 1 + runtime.403eb08f2aeaa66c.js | 1 + styles.8bd3f8433cd66003.css | 1 + 47 files changed, 886 insertions(+) create mode 100644 3rdpartylicenses.txt create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 Roboto-Black.2eaa390d458c877d.woff2 create mode 100644 Roboto-Black.b25f67ad8583da68.woff create mode 100644 Roboto-BlackItalic.7dc03ee444552bc5.woff2 create mode 100644 Roboto-BlackItalic.c8dc642467cb3099.woff create mode 100644 Roboto-Bold.447291a88c067396.woff2 create mode 100644 Roboto-Bold.fc482e6133cf5e26.woff create mode 100644 Roboto-BoldItalic.1b15168ef6fa4e16.woff2 create mode 100644 Roboto-BoldItalic.e26ba339b06f09f7.woff create mode 100644 Roboto-Light.0e01b6cd13b3857f.woff2 create mode 100644 Roboto-Light.603ca9a537b88428.woff create mode 100644 Roboto-LightItalic.1b5e142f787151c8.woff create mode 100644 Roboto-LightItalic.232ef4b20215f720.woff2 create mode 100644 Roboto-Medium.457532032ceb0168.woff2 create mode 100644 Roboto-Medium.6e1ae5f0b324a0aa.woff create mode 100644 Roboto-MediumItalic.872f7060602d55d2.woff2 create mode 100644 Roboto-MediumItalic.e06fb533801cbb08.woff create mode 100644 Roboto-Regular.475ba9e4e2d63456.woff2 create mode 100644 Roboto-Regular.bcefbfee882bc1cb.woff create mode 100644 Roboto-RegularItalic.0668fae6af0cf8c2.woff create mode 100644 Roboto-RegularItalic.e3a9ebdaac06bbc4.woff2 create mode 100644 Roboto-Thin.c13c157cb81e8ebb.woff create mode 100644 Roboto-Thin.f7a95c9c5999532c.woff2 create mode 100644 Roboto-ThinItalic.1111028df6cea564.woff create mode 100644 Roboto-ThinItalic.b0e084abf689f393.woff2 create mode 100644 assets/minimalConfigDemo.jpg create mode 100644 assets/screenshot.jpg create mode 100644 favicon.ico create mode 100644 index.html create mode 100644 main.986a45e093da463f.js create mode 100644 material-icons-outlined.78a93b2079680a08.woff create mode 100644 material-icons-outlined.f86cb7b0aa53f0fe.woff2 create mode 100644 material-icons-round.92dc7ca2f4c591e7.woff create mode 100644 material-icons-round.b10ec9db5b7fbc74.woff2 create mode 100644 material-icons-sharp.3885863ee4746422.woff2 create mode 100644 material-icons-sharp.a71cb2bf66c604de.woff create mode 100644 material-icons-two-tone.588d63134de807a7.woff create mode 100644 material-icons-two-tone.675bd578bd14533e.woff2 create mode 100644 material-icons.4ad034d2c499d9b6.woff create mode 100644 material-icons.59322316b3fd6063.woff2 create mode 100644 polyfills.fe77287e05f61a9e.js create mode 100644 publish_date.txt create mode 100644 runtime.403eb08f2aeaa66c.js create mode 100644 styles.8bd3f8433cd66003.css diff --git a/3rdpartylicenses.txt b/3rdpartylicenses.txt new file mode 100644 index 0000000..33d3665 --- /dev/null +++ b/3rdpartylicenses.txt @@ -0,0 +1,312 @@ +@angular/animations +MIT + +@angular/cdk +MIT +The MIT License + +Copyright (c) 2023 Google LLC. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +@angular/common +MIT + +@angular/core +MIT + +@angular/forms +MIT + +@angular/material +MIT +The MIT License + +Copyright (c) 2023 Google LLC. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +@angular/platform-browser +MIT + +mat-image-overlay +MIT + +rxjs +Apache-2.0 + 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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 (c) 2015-2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors + + 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. + + + +tslib +0BSD +Copyright (c) Microsoft Corporation. + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. + +zone.js +MIT +The MIT License + +Copyright (c) 2010-2023 Google LLC. https://angular.io/license + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4ea6172 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,130 @@ +# Changelog + +All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. + +### [15.1.4](https://github.com/BePo65/mat-image-overlay/compare/v15.1.3...v15.1.4) (2023-11-02) + +### [15.1.3](https://github.com/BePo65/mat-image-overlay/compare/v15.1.2...v15.1.3) (2023-05-24) + +### [15.1.2](https://github.com/BePo65/mat-image-overlay/compare/v15.1.1...v15.1.2) (2023-05-24) + +### [15.1.1](https://github.com/BePo65/mat-image-overlay/compare/v15.1.0...v15.1.1) (2023-01-14) + +## [15.1.0](https://github.com/BePo65/mat-image-overlay/compare/v15.0.0...v15.1.0) (2023-01-14) + + +### ⚠ BREAKING CHANGES + +* drops 'imageClickHandler' from configuration and moves +it as an observable to 'MatImageOverlayRef' + +### Features + +* embed roboto font instead of linking it ([de1fab3](https://github.com/BePo65/mat-image-overlay/commit/de1fab36e67d4dc6e0c8f7781e240da87310c510)) +* replace option 'imageClickHandler' with observable ([70c9442](https://github.com/BePo65/mat-image-overlay/commit/70c94424276756d3890b1ede108b19d09feb1658)) + +## [15.0.0](https://github.com/BePo65/mat-image-overlay/compare/v3.0.3...v15.0.0) (2023-01-04) + + +### Bug Fixes + +* errors from stylelint ([99e4cea](https://github.com/BePo65/mat-image-overlay/commit/99e4cea75365476dac210157128b7e10f6068b69)) +* type error in event handler ([712b2c6](https://github.com/BePo65/mat-image-overlay/commit/712b2c61a96c0bd365d04488aa304b84baa450e6)) +* warnings from upgrading to angular v15 ([a87f141](https://github.com/BePo65/mat-image-overlay/commit/a87f14124353bef3db5e025b277955ff664ad34a)) + +### [3.0.3](https://github.com/BePo65/mat-image-overlay/compare/v3.0.2...v3.0.3) (2022-07-10) + +### [3.0.2](https://github.com/BePo65/mat-image-overlay/compare/v3.0.1...v3.0.2) (2022-01-30) + +### [3.0.1](https://github.com/BePo65/mat-image-overlay/compare/v3.0.0...v3.0.1) (2022-01-30) + +## [3.0.0](https://github.com/BePo65/mat-image-overlay/compare/v2.0.0...v3.0.0) (2022-01-30) + + +### ⚠ BREAKING CHANGES + +* remove 'with' and filter from MatImageOverlayHarness +as this feature is unnecessary (only 1 MatImageOverlay can be created +at one time). + +### Features + +* add 'imageUrl' and 'sendKeys' to MatImageOverlayHarness ([e08547a](https://github.com/BePo65/mat-image-overlay/commit/e08547a69ed9c5ef7451f80ca270cdff159ba856)) +* move host() of MatImageOverlayHarness to overlayContainer ([3becd0d](https://github.com/BePo65/mat-image-overlay/commit/3becd0d26312f4c19e4a6f034e5cbded4ce2761d)) +* remove 'with' and filter from MatImageOverlayHarness ([e577640](https://github.com/BePo65/mat-image-overlay/commit/e5776405db87f124a858804efc264a97dc58b9e4)) +* remove sendKeysWithModifiers as modifiers are not evaluated ([eb57718](https://github.com/BePo65/mat-image-overlay/commit/eb57718bd8679a9a6fe47d551ef72bd15c9c5f55)) + +## [2.0.0](https://github.com/BePo65/mat-image-overlay/compare/v1.0.0...v2.0.0) (2022-01-26) + + +### ⚠ BREAKING CHANGES + +* add navigation to ImageOverlayComponentRef. +'Law of demeter' says that accessing properties of components in +another component is bad practice. +* images in config is now required; optional parameters +don't have a default value anymore. +* use MatImageOverlayConfig as parameter of 'open' +to combine all parameters into one single parameter. +* 'open()' requires index of image not url +* component names changed to be consistent with project +names + +### Features + +* activate events ([58d57a2](https://github.com/BePo65/mat-image-overlay/commit/58d57a2bfecb6b8a241c360bb3f4c9389f1021fc)) +* add config class to public api ([742f65d](https://github.com/BePo65/mat-image-overlay/commit/742f65d5949ac1271e8222173d8de8a5afefdfbe)) +* add config option for position of description when style='onHover' ([94805ea](https://github.com/BePo65/mat-image-overlay/commit/94805ea89c724eba754055ef6a4af1c008e1bc30)) +* add demo with minimal required configuration ([2d0b664](https://github.com/BePo65/mat-image-overlay/commit/2d0b6646b6dab781e2c6694d93c5a347a459bf09)) +* add gotoImage and gotoLastImage to automatic demo ([fbcd5ed](https://github.com/BePo65/mat-image-overlay/commit/fbcd5edd7f5ed121c954b3b27281a55b5f25d602)) +* add home and end button to move in list of images ([4281aa1](https://github.com/BePo65/mat-image-overlay/commit/4281aa14a6f66d660246ca6f89f401b11d7d0ded)) +* add navigation buttons to overlay image ([cda1c84](https://github.com/BePo65/mat-image-overlay/commit/cda1c84b380e17dfb3a5f3ddcec1d7a8c470a30f)) +* add option 'descriptionForImage' to string source demo ([615bf8e](https://github.com/BePo65/mat-image-overlay/commit/615bf8e062ef5839c133aff6a791e9f53994f090)) +* add option for click event handler of image ([e054290](https://github.com/BePo65/mat-image-overlay/commit/e054290ea6815435372d3d2cafda87536bae8881)) +* add option to access description of image ([3e3f835](https://github.com/BePo65/mat-image-overlay/commit/3e3f83596b70931b80bac5525dc8bf870d1cf99a)) +* add option to set display style for overlay buttons ([f28d663](https://github.com/BePo65/mat-image-overlay/commit/f28d6636a6fe6dcb99eb62702835b6849e1d9ce9)) +* add property to optionally display an image description ([c01df2d](https://github.com/BePo65/mat-image-overlay/commit/c01df2de5e42fcb41d265779112294d24b4ab057)) +* add testHarness for mat-image-overlay ([1a12bba](https://github.com/BePo65/mat-image-overlay/commit/1a12bba725d7c108a583795d47fa74cdf0061967)) +* add title and short description to demo page ([72254c4](https://github.com/BePo65/mat-image-overlay/commit/72254c44cbe110c7bc9b949064ebe1817c3523a0)) +* add tooltip to link images of demo page ([9052f14](https://github.com/BePo65/mat-image-overlay/commit/9052f1429f22d1746c7935ca924c8381781fab13)) +* always show buttons on devices that do not support 'hover' ([f7198e5](https://github.com/BePo65/mat-image-overlay/commit/f7198e54bd84bdf852bb8b85fdeba56928e47d29)) +* change call signature of 'open' method of MatImageOverlay ([2dc7f02](https://github.com/BePo65/mat-image-overlay/commit/2dc7f0297d043cfea8c0ffeb8826db32f3e3d409)) +* default implementation for 'urlForImage' accecpts empty 'images' ([6b7fe6f](https://github.com/BePo65/mat-image-overlay/commit/6b7fe6f7378da1498a154a1af972aa3a10322066)) +* define start image in overlay via index (not url) ([8c1e980](https://github.com/BePo65/mat-image-overlay/commit/8c1e9809ea3752900430e544ca4e4ea0330bd29f)) +* descriptionDisplayStyle 'onHover' shows text on bottom of image ([d8de396](https://github.com/BePo65/mat-image-overlay/commit/d8de3964c66c9120163db1197c9a5d0241fecb34)) +* extend demo to show external navigation ([38d95cc](https://github.com/BePo65/mat-image-overlay/commit/38d95ccdb3e0978c218bee3b6e21c40d52be31d6)) +* hide buttons for next / previous image on limits of list ([2499c29](https://github.com/BePo65/mat-image-overlay/commit/2499c29c97f09c007826218d199f3d58b31681f6)) +* hide description if value is undefined or empty string ([461ced8](https://github.com/BePo65/mat-image-overlay/commit/461ced88f2048c398bb5b16e59f5482682c5bb35)) +* increase size of images to fill viewport ([db57483](https://github.com/BePo65/mat-image-overlay/commit/db57483302222fefbb0e1481545cf61de4d156ab)) +* make 'mat-image-overlay-ref' available in mat-image-overlay ([04ec39f](https://github.com/BePo65/mat-image-overlay/commit/04ec39fc37854331e7b25c64a0906b4cf45cb0b1)) +* make 'open' return a MatImageOverlayRef object ([c084f0f](https://github.com/BePo65/mat-image-overlay/commit/c084f0fb2b8bef01025e1769ee395dacf5654b7a)) +* make configuration of datasource more flexible ([4d5b766](https://github.com/BePo65/mat-image-overlay/commit/4d5b7668966e1ec60c38e18b3dfc802d6c2ca357)) +* make images a required parameter of MatImageOverlayConfig ([7082f31](https://github.com/BePo65/mat-image-overlay/commit/7082f317a359dab7ec7831af5efc8909d9be4c3d)) +* make MatImageOverlayConfig an interface ([560f6de](https://github.com/BePo65/mat-image-overlay/commit/560f6de525fbc72c16b9eb78bd471714d6cbcad9)) +* make option 'urlForImage' optional ([4511ad9](https://github.com/BePo65/mat-image-overlay/commit/4511ad96016a01625adf34df61b232ebbf546819)) +* make sure that only 1 instance of MatImageOverlay exists ([e03e01c](https://github.com/BePo65/mat-image-overlay/commit/e03e01c583ea23be20f40690a6f6796a83982db9)) +* remove 'panelClass' from config and mat-image-overlay-ref ([0ea0987](https://github.com/BePo65/mat-image-overlay/commit/0ea098705960863fb44b5c7cce9aa9a01631ec74)) +* remove access to OverlayComponent in OverlayComponentRef ([f8119d6](https://github.com/BePo65/mat-image-overlay/commit/f8119d67fb3e63f76d568c79ecd33e3b2d25ba7f)) +* show options in demo page in right column ([85fbb87](https://github.com/BePo65/mat-image-overlay/commit/85fbb871cb832c6a6ff8626f1f508429a309696c)) + + +### Bug Fixes + +* activate configuration parameter 'backdropClass' ([af220c7](https://github.com/BePo65/mat-image-overlay/commit/af220c707981d96d0718419282fb5e839291749f)) +* add css to keep ascpect ratio of image when resizing browser ([6fd2bcc](https://github.com/BePo65/mat-image-overlay/commit/6fd2bccd54662e8cff2069353fc266e498840966)) +* add visibility of public methods, remove unnecessary 'getState' ([b877798](https://github.com/BePo65/mat-image-overlay/commit/b8777988dd8c303e821a1320efc7d1ebe5971485)) +* change svg icons to constants ([dd18545](https://github.com/BePo65/mat-image-overlay/commit/dd185454c21e28a5c1f535eae1e33731ea155d6d)) +* prevent keystrokes from overlay to be sent to parent page ([e4f12c5](https://github.com/BePo65/mat-image-overlay/commit/e4f12c57decdb9c5455b2d1299d55ae33dd5d4b1)) +* remove base from index.html of demo ([01d21e0](https://github.com/BePo65/mat-image-overlay/commit/01d21e0f245518f7629076224e2355581dfa5f8a)) +* rename 'AngularMaterialImageOverlay...' to 'MatImageOverlay...' ([c55177b](https://github.com/BePo65/mat-image-overlay/commit/c55177b3cd4a528aee77d9fe8fc5f1f4cd8394bb)) +* stop loop when 'imgage show' is manually closed ([d632a93](https://github.com/BePo65/mat-image-overlay/commit/d632a93b614fc96126ac207a1bcb3544b6a972b7)) +* stylelint request shorthand for css grid ([5cec9fa](https://github.com/BePo65/mat-image-overlay/commit/5cec9faabf19a059aef0bd4b61d1be411f90259a)) +* update demo to show different data sources ([214be52](https://github.com/BePo65/mat-image-overlay/commit/214be522eb50b10772264c95134fc6502858b175)) +* update layout of demo page ([c0803a0](https://github.com/BePo65/mat-image-overlay/commit/c0803a0972ba4eb8da3d11f76d0cdba6bd714b83)) +* update tests to current version ([20479b8](https://github.com/BePo65/mat-image-overlay/commit/20479b83a9e8bc117f7b93756bc3f4e99af494bd)) + +## [1.0.0](///compare/v0.0.8-next...v1.0.0) (2021-12-16) + +# Changelog + +All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0e6a700 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Rafael Santos + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a23641b --- /dev/null +++ b/README.md @@ -0,0 +1,407 @@ +# Mat-Image-Overlay +![Version](https://img.shields.io/badge/version-15.1.4-blue.svg?cacheSeconds=2592000) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) + +An [Angular Material](https://material.angular.io/) based component that shows images in an overlay. +The component is based on Rafasantos [angular-material-image-overlay](https://github.com/rafasantos/angular-material-image-overlay). + +## Demo + Try out the [demo page](https://bepo65.github.io/mat-image-overlay/). + +![Screenshot](assets/screenshot.jpg "Screenshot of the demo page") + +## Quick Start +Install the package: + +``` +npm install mat-image-overlay +``` + +Configure your angular application module (e.g: `app.module.ts`): +``` +... +import { MatImageOverlayModule } from 'mat-image-overlay'; + +@NgModule({ + ... + imports: [ + ... + MatImageOverlayModule + ] +}) +export class AppModule { } +``` + +Define a class based on MatImageDetailsProvider to get information about the images and create an instance of it in the mat-image-overlay configuration. Examples for classes based on MatImageDetailsProvider can be found in the 'examples/provider' directory of the mat-image-overlay component. +``` +images = [ + 'https://url/of/first/image.jpg', + 'https://url/of/second/image.jpg', + 'https://url/of/third/image.jpg', + 'https://url/of/fourth/image.jpg' +]; + +constructor(private imageOverlay: MatImageOverlay) { +} + +openImageOverlay(imageIndex?: number): void { + const config = { + imageDetails: new StringSourceImageDetailsProvider(this.images), + startImageIndex: imageIndex, + backdropClass: 'demo-backdrop-class' + } as MatImageOverlayConfig; + const imageOverlayRef = this.imageOverlay.open(config); +} +``` + +Open the overlay via a clickable element in your html template (e.g. `app.component.html`) +```html +

+ Click here to open the overlay +

+``` +## Navigation +When the overlay is shown, the keyboard can be used to navigate between the images (even when no navigational buttons are displayed on the image). The following keys are available: + +| key | function | +|-----|----------| +| Arrow Right | show next image | +| Arrow Down | show next image | +| Arrow Left | show previous image | +| Arrow Up | show previous image | +| Home | show first image | +| End | show last image | +| Escape | close overlay | + +## Used assets +The component is based on Angular Material and uses [Google Fonts](https://fonts.google.com/specimen/Roboto) and [Google Material Icons](https://google.github.io/material-design-icons/#icon-font-for-the-web). +Both fonts are part of the project and not fetched via https. + +Some special icons are stored in the code as strings representing the icons as svg graphics. + +## Mat-Image-Overlay Demo +Demo project to show case how `mat-image-overlay` works. + +``` +git clone git@github.com:BePo65/mat-image-overlay.git +cd mat-image-overlay +npm start +``` + +Navigate to http://localhost:4200 + +# API reference for Mat-Image-Overlay + +## Services +### MatImageOverlay +Service to open Mat-Image-Overlay as a modal overlay. + +**Properties** +| Name | Description | +|---|---| +| imageOverlayRef: MatImageOverlayRef | undefined | Reference of the opened image overlay. | +| afterOpened: Subject<MatImageOverlayRef> | Stream that gets notified when the image overlay has been opened. | +| afterClosed: Subject<number> | Stream that gets notified when the image overlay has been closed. | + +**Methods** +| open | | +|---|--| +| Opens the image overlay. | | +| *Parameters* | | +| config
MatImageOverlayConfig | Extra configuration options. | +| *Returns* | | +| MatImageOverlayRef | Reference to opened image overlay. + +| imageOverlayExists | | +|---|--| +| Checks whether the image overlay already exists. | | +| *Returns* | | +| boolean | true = image overlay exists | + +## Interfaces +### MatImageOverlayConfig +Configuration for opening a modal image overlay with the MatImageOverlay service. + +**Properties** +| Name | Description | +|---|---| +| imageDetails | Instance of a class derived from MatImageDetailsProvider. | +| startImageIndex | Index of the first image to be displayed (0 based). | +| backdropClass | CSS class to add to the backdrop, replacing the default backdrop css. This CSS class must be in the global styles of the application.
Default style is '`background: rgba(0 0 0 / 32%);`'
Optional parameter. | +| overlayButtonsStyle | Style of the buttons in the image overlay (using enum ElementDisplayStyle: never, onHover, always). Default value: onHover.
Optional parameter. | +| descriptionDisplayStyle | Style of the display of the image description in the image overlay (using enum ElementDisplayStyle: never, onHover, always). Default value: never. Requires a property named 'description' in data source.
Optional parameter. | +| descriptionDisplayPosition | Position of the display of the image description in the image overlay (using enum ElementDisplayPosition: left, right) when 'descriptionDisplayStyle' is set to 'onHover'. Default value: right. Requires a property named 'description' in data source.
Optional parameter. | +| imageClickedAdditionalData | Object with arbitrary data that will be returned by the imageClicked event (added to the data returned by the 'imageDetails.imageInformation' method).
Optional parameter. | + +### MatImageDetailsProvider +Abstract base class to be derived by a real image details provider. This class is used to get all the required information about an image. + +**Properties** +| Name | Description | +|---|---| +| numberOfImages | Number of images that can be displayed (this property is readonly). | + +**Methods** +| urlForImage | | +|---|--| +| Gets the url for an image. | | +| *Parameters* | | +| imageIndex | Index of the image to be displayed (0 based). | +| *Returns* | | +| string | Url for the image to be displayed. | + +| descriptionForImage | | +|---|--| +| Gets the description for an image. | | +| *Parameters* | | +| imageIndex | Index of the image to be displayed (0 based). | +| *Returns* | | +| string | Url for the image to be displayed. | + +| imageInformation | | +|---|--| +| Gets a record that contains information about an image. | The returned object is part of the data returned by the imageClicked event. | +| *Parameters* | | +| imageIndex | Index of the clicked image (0 based). | +| *Returns* | | +| Record | Object with additional data about the image. | + +## Classes +### MatImageOverlayRef +Reference to an image overlay opened via the MatImageOverlay service. + +**Properties** +| Name | Description | +|---|---| +| numberOfImages | number of images that can be displayed. | +| keydownEvents$ | Observable that is notified by keydown events on the overlay. Navigation buttons don't get emitted. | + +**Methods** +| close | | +|---|--| +| Closes the image overlay. | | +| *Parameters* | | +| lastImageIndex | Index of the last image displayed in the overlay. | + +| afterOpened | | +|---|--| +| Gets an observable that is notified when the image overlay is finished opening. | | +| *Returns* | | +| Observable<void> | Observable that fires, when the overlay has been opened. | + +| afterClosed | | +|---|--| +| Gets an observable that is notified when the image overlay is finished closing. | | +| *Returns* | | +| Observable<number> | Observable that returns the index of the last image displayed. | + +| imageChanged | | +|---|--| +| Gets an observable that is notified when a new image has been selected. | | +| *Returns* | | +| Observable<number> | Observable that returns the index of the image displayed. | + +| imageClicked | | +|---|--| +| Gets an observable that is notified when an image has been clicked. | | +| *Returns* | | +| Observable<ImageClickedEvent> | Observable that returns the object with data of the clicked image and the imageClickedConfiguration object from the config object. | + +### MatImageOverlayComponent +Component used by MatImageOverlay to display the images in the modal overlay. + +**Properties** +| Name | Description | +|---|---| +| numberOfImages | number of images that can be displayed. | + +**Methods** +| gotoNextImage | | +|---|--| +| Display the next image in the datasource. | | + +| gotoPreviousImage | | +|---|--| +| Display the previous image in the datasource. | | + +| gotoFirstImage | | +|---|--| +| Display the first image in the datasource. | | + +| gotoLastImage | | +|---|--| +| Display the last image in the datasource. | | + +| gotoImage | | +|---|--| +| Display the image in the datasource selected by the imageIndex. | | +| *Parameters* | | +| imageIndex | Index of the image to be displayed. | + +# API reference for Mat-Image-Overlay testing + +```typescript +import { MatImageOverlayHarness } from 'mat-image-overlay/testing'; +``` +## Classes +### MatImageOverlayHarness extends ContentContainerComponentHarness +Harness for interacting with a standard MatImageOverlay in tests. + +**Properties** +| Name | Description | +|---|---| +| static hostSelector: '.mat-image-overlay-container' | The selector for the host element of a MatImageOverlay instance. | + +**Methods** +| async overlayIsLoaded | | +|---|--| +| Gets a promise that fulfills to true, when the image overlay is visible. | | +| *Returns* | | +| Promise<boolean> | Promise that fulfills to a flag that shows, if the image overlay is visible. + +| async close | | +|---|--| +| Closes the image overlay by pressing escape. | | +| *Returns* | | +| Promise<void> | Promise that fulfills, when the action completes. + +| async clickBackdrop | | +|---|--| +| Closes the image overlay by clicking the backdrop of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that fulfills, when the action completes. + +| async buttonCloseVisible | | +|---|--| +| Gets a promise that fulfills to true, when the 'close' button is visible. | | +| *Returns* | | +| Promise<boolean> | Promise that fulfills to a flag that shows, if the 'close' button is visible. + +| async buttonPreviousVisible | | +|---|--| +| Gets a promise that fulfills to true, when the 'previous' button is visible. | | +| *Returns* | | +| Promise<boolean> | Promise that fulfills to a flag that shows, if the 'previous' button is visible. + +| async buttonNextVisible | | +|---|--| +| Gets a promise that fulfills to true, when the 'next' button is visible. | | +| *Returns* | | +| Promise<boolean> | Promise that fulfills to a flag that shows, if the 'next' button is visible. + +| async descriptionVisible | | +|---|--| +| Gets a promise that fulfills to true, when the 'description' of the image is visible. | | +| *Returns* | | +| Promise<boolean> | Promise that fulfills to a flag that shows, if the 'description' is visible. + +| async clickCloseButton | | +|---|--| +| Clicks the 'close overlay' button of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that fulfills, when the action completes. + +| async clickPreviousButton | | +|---|--| +| Clicks the 'goto previous image' button of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that fulfills, when the action completes. + +| async clickNextButton | | +|---|--| +| Clicks the 'goto next image' button of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that fulfills, when the action completes. + +| async figureHover | | +|---|--| +| Sets the figure tag of the overlay (the content of the overlay) into the hover state. | | +| *Returns* | | +| Promise<void> | Promise that fulfills, when the action completes. + +| async imageUrl | | +|---|--| +| Gets a promise that fulfills to the url of the current image in the overlay. | | +| *Returns* | | +| Promise<boolean> | Promise that fulfills to the url of the image or to an empty string. + +| async sendKeys | | +|---|--| +| Send keys to the overlay. | | +| *Parameters* | | +| ...keys | Array of 'TestKey' to be sent. Possible values are the arrow keys, the home and the end key. | +| *Returns* | | +| Promise<void> | Promise that resolves when the action completes. + +| async hasBackdropClass | | +|---|--| +| Gets a promise that fulfills to true, when the backdrop contains the given css class. | | +| *Parameters* | | +| classname | Name of the css class to be evaluated. | +| *Returns* | | +| Promise<boolean> | Promise fulfills to a flag that shows, if the backdrop contains the given css class. + +# Development +Build the library and the demo project: +``` +npm run build +``` + +Lint the library, the demo project with eslint and the scss files with stylelint: +``` +npm run lint +npm run lint:scss +``` + +Test the library and the demo project: +``` +npm run test +``` + +Run component tests for the library project with cypress once (e.g. for CI scenarios): +``` +npm run ct +``` + +Run end to end tests for the demo project with cypress once (e.g. for CI scenarios): +``` +npm run e2e +``` +The script 'build:ghpages' is used by the github automation to publish the demo to github pages, when the master branch is updated. + +# Contributing +## Changelog +The project uses 'standard-version' to create the changelog. To enable this system, commit messages are linted before commits are executed by git. + +**The structure of commit messages is**: +``` +
+ + + +