From c2b13d5df5b5f5fd0d6c67808f05fa71a1f02fdf Mon Sep 17 00:00:00 2001 From: Github Pages Overwriter Date: Mon, 2 Oct 2023 05:15:05 +0000 Subject: [PATCH] Automated publish --- 3rdpartylicenses.txt | 334 ++++++++++++++++ LICENSE | 21 + README.md | 377 ++++++++++++++++++ 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 -> 27970 bytes assets/screenshot.jpg | Bin 0 -> 140200 bytes favicon.ico | Bin 0 -> 5430 bytes index.html | 11 + main.fb41b1c9b42348e5.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.9d31a4e7976d51ff.css | 1 + 46 files changed, 748 insertions(+) create mode 100644 3rdpartylicenses.txt 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.fb41b1c9b42348e5.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.9d31a4e7976d51ff.css diff --git a/3rdpartylicenses.txt b/3rdpartylicenses.txt new file mode 100644 index 0000000..733d0d1 --- /dev/null +++ b/3rdpartylicenses.txt @@ -0,0 +1,334 @@ +@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 +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. + + +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/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..7a40890 --- /dev/null +++ b/README.md @@ -0,0 +1,377 @@ +# Mat-Image-Overlay +![Version](https://img.shields.io/badge/version-15.1.3-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 function to open the images in your application component (e.g. `app.component.ts`) +``` +images = [ + 'https://www.jpl.nasa.gov/spaceimages/images/wallpaper/PIA23618-1024x768.jpg', + 'https://www.jpl.nasa.gov/spaceimages/images/wallpaper/PIA23761-800x600.jpg', + 'https://www.jpl.nasa.gov/spaceimages/images/wallpaper/PIA23794-800x600.jpg', + 'https://www.jpl.nasa.gov/spaceimages/images/wallpaper/PIA23214-1440x900.jpg' +]; + +constructor(private imageOverlay: MatImageOverlay) { +} + +openImageOverlay(imageIndex?: number): void { + const config = { + images: 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 +

+``` + +## 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 modal overlay. + +**Properties** +| Name | Description | +|---|---| +| imageOverlayRef: MatImageOverlayRef | undefined | Reference of the opened image overlay. | +| afterOpened: Subject<MatImaeOverlayRef> | 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 | | + +## Interfaces +### MatImageOverlayConfig +Configuration for opening a modal image overlay with the MatImageOverlay service. + +**Methods** +| urlForImage | | +|---|--| +| Gets the url for an image for one entry of images array. | This function is optional. The default implementation expects 'images' to be an array of strings. | +| *Parameters* | | +| imageData | Data for the image. | +| baseUrl | Url fragment to be used for building the image url. Optional parameter. | +| *Returns* | | +| string | Url for the image to be displayed. | + +| descriptionForImage | | +|---|--| +|This method gets called to fetch the image description. | This function is optional. | +| *Parameters* | | +| imageData | Data for the image. | +| configuration | Additional parameters defined as 'descriptionForImageConfiguration' in the MatImageOverlayConfig object. | + +**Properties** +| Name | Description | +|---|---| +| images | Array of the images to display. | +| baseUrl | Base url to be used by method 'urlForImage'.
Optional parameter. | +| startImageIndex | Index of the image to be displayed when initializing the image overlay.
Optional parameter. | +| backdropClass | CSS class to add to the backdrop, replacing the default backdrop css.
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 propert named 'description' in data source.
Optional parameter. | +| imageClickHandlerConfiguration | Object with arbitrary data as parameter of the 'imageClickHandler' method.
Optional parameter. | +| descriptionForImageConfiguration | Object with arbitrary data as parameter of the 'descriptionForImage' method.
Optional parameter. | + +## Classes +### MatImageOverlayRef +Reference to an image overlay opened via the MatImageOverlay service. + +**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> | | + +| afterClosed | | +|---|--| +| Gets an observable that is notified when the image overlay is finished closing. | | +| *Returns* | | +| Observable<number> | Observable returns index of the last image displayed. | + +| imageChanged | | +|---|--| +| Gets an observable that is notified when a new image has been selected. | | +| *Returns* | | +| Observable<number> | Observable returns index of the image displayed. | + +| imageClicked | | +|---|--| +| Gets an observable that is notified when an image has been clicked. | | +| *Returns* | | +| Observable<ImageClickedEvent> | Observable returns object with data of the clicked image and imageClickedConfiguration object from the config object. | + +| keydownEvents | | +|---|--| +| Gets an observable that is notified when keydown events are targeted on the overlay. | | +| *Returns* | | +| Observable<number> | Observable returns index of the image displayed. | + +### MatImageOverlayComponent +Component used by MatImageOverlay to display the images in the modal overlay. + +**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 flag that is true, when the image overlay is visible. | | +| *Returns* | | +| Promise<boolean> | Flag that shows, if the image overlay is visible. + +| async close | | +|---|--| +| Closes the image overlay by pressing escape. | | +| *Returns* | | +| Promise<void> | Promise that resolves when the action completes.. + +| async clickBackdrop | | +|---|--| +| Closes the image overlay by clicking the backdrop of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that resolves when the action completes.. + +| async buttonCloseVisible | | +|---|--| +| Gets a flag that is true, when the 'close' button is visible. | | +| *Returns* | | +| Promise<boolean> | Flag that shows, if the 'close' button is visible. + +| async buttonPreviousVisible | | +|---|--| +| Gets a flag that is true, when the 'previous' button is visible. | | +| *Returns* | | +| Promise<boolean> | Flag that shows, if the 'previous' button is visible. + +| async buttonNextVisible | | +|---|--| +| Gets a flag that is true, when the 'next' button is visible. | | +| *Returns* | | +| Promise<boolean> | Flag that shows, if the 'next' button is visible. + +| async descptionVisible | | +|---|--| +| Gets a flag that is true, when the 'description' of the image is visible. | | +| *Returns* | | +| Promise<boolean> | Flag that shows, if the 'description' is visible. + +| async clickCloseButton | | +|---|--| +| Clicks the 'close overlay' button of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that resolves when the action completes.. + +| async clickPreviousButton | | +|---|--| +| Clicks the 'goto previous image' button of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that resolves when the action completes.. + +| async clickNextButton | | +|---|--| +| Clicks the 'goto next image' button of the image overlay. | | +| *Returns* | | +| Promise<void> | Promise that resolves 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 resolves when the action completes.. + +| async imageUrl | | +|---|--| +| Gets the url of the current image in the overlay. | | +| *Returns* | | +| Promise<boolean> | Url of the image or empty string. + +| async sendKeys | | +|---|--| +| Send keys to the overlay. | | +| *Parameters* | | +| ...keys
TestKey[] | Keys to be sent. Posiible 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 flag that is true, when the backdrop contains the given css class. | | +| *Parameters* | | +| classname
string | Name of the css class to be evaluated. | +| *Returns* | | +| Promise<boolean> | 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 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. + +## Open issues + - − + +## 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). +Bith 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. + +## Version hint +* currently no hints (we are on Angular 15) + +# 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**: +``` +
+ + + +