@ks89/angular-modal-gallery

New package >=6:

Old package <=5:

Do you like angular-modal-gallery? Please, add a 'star' to support this library

angular-modal-gallery

angular-modal-gallery is an Angular library (SSR compatible) to create image galleries of clickable thumbnails. After a click, it will display a modal window with full screen images. Modal view is composed by buttons, the current image and optionally, also navigation dots and previews.
It's also possible to navigate between these modal images with both keyboard arrows, swipe gestures and mouse clicks and close it pressing esc.

This library uses Semantic versioning 2.0.0 also known as 'semver'

angular-modal-gallery requires Internet Explorer >= 11 and Angular >= 5

Features

• Angular module to import this library
• works with IE >= 11
• AOT support
• Angular >= 5
• compliant to Angular Package Format v5 specifications
• official examples with angular-cli, angular-cli-5, angular-cli + material, SystemJS and angular-universal HERE
• unit testing with high % coverage
• Server Side Rendering support with angular-universal (from version 5.2.0)
• Web Accessibility features, like ARIA support and toptal.com criteria (tested with Sim Daltonism for macOS)
• image download with buttons or keyboard shortcuts
• advanced keyboard shortcuts with mousetrap (both local and global)
• fully configurable default buttons to either close, download, navigate to an external url or delete images
• support custom buttons with both pre and after hooks
• click outside feature to close the modal gallery clicking on the background
• configurable plain gallery
• configurable side-previews (visible only on bigger screen)
• configurable dots navigation (visible only on bigger screen)
• configurable previews (visible only on bigger screen)
• and so on... (check the official documentation HERE)

Documentation

Image loading could be slow, because this website is hosted on Github pages

OFFICIAL DOCUMENTATION WEBSITE

Live demo

OFFICIAL LIVE DEMO

Installation

• npm install --save @ks89/angular-modal-gallery
• npm install --save hammerjs mousetrap
• npm install --save-dev @types/mousetrap @types/hammerjs

From version 5.0.0, font-awesome isn't a mandatory dependency. You can use all default features without font-awesome. For more info, check official documentation website.

Which version should I use?

	angular-modal-gallery	font-awesome
AngularJS	NOT SUPPORTED
Angular 2	<= 3.3.5	>= 4.0.0
Angular 4	<= 5.5.0	optional
Angular 5	>= 5.0.0	optional
Angular 6	>= 5.4.0	optional

News

• 06/10/2018 - 6.0.0 - angular-modal-gallery - HERE
• 06/03/2018 - 6.0.0-beta.2 - angular-modal-gallery - HERE
• 05/14/2018 - 6.0.0-beta.1 - angular-modal-gallery - HERE
• 05/07/2018 - 6.0.0-alpha.4 - angular-modal-gallery - HERE
• 05/06/2018 - 5.7.1 - angular-modal-gallery - HERE
• 05/05/2018 - 5.7.0 - angular-modal-gallery - HERE
• 05/02/2018 - 6.0.0-alpha.3 - angular-modal-gallery - HERE
• 01/05/2018 - 5.6.0 - angular-modal-gallery - HERE
• 04/27/2018 - 5.6.0-beta.1 - angular-modal-gallery - HERE
• 04/27/2018 - 5.5.1 - angular-modal-gallery - HERE
• 04/07/2018 - 5.5.0 - angular-modal-gallery - HERE
• 04/03/2018 - 5.4.0 - angular-modal-gallery - HERE
• 04/03/2018 - 5.4.0-beta.3 - angular-modal-gallery - HERE
• 03/31/2018 - 6.0.0-alpha.2 - angular-modal-gallery - HERE
• 03/30/2018 - 6.0.0-alpha.1 - angular-modal-gallery - HERE
• 03/28/2018 - 5.4.0-beta.2 - angular-modal-gallery - HERE
• 03/28/2018 - 5.4.0-beta.1 - angular-modal-gallery - HERE
• 03/24/2018 - 5.3.0 - angular-modal-gallery - HERE
• 03/18/2018 - 5.3.0-beta.1 - angular-modal-gallery - HERE
• 03/18/2018 - 5.2.2 - angular-modal-gallery - HERE
• 03/15/2018 - 5.2.1 - angular-modal-gallery - HERE
• 03/08/2018 - 5.2.0 - angular-modal-gallery - HERE
• 03/05/2018 - 5.2.0-beta.1 - angular-modal-gallery - HERE
• 03/04/2018 - 5.1.0 - angular-modal-gallery - HERE
• 03/04/2018 - 5.1.0-beta.2 - angular-modal-gallery - HERE
• 03/01/2018 - 5.1.0-beta.1 - angular-modal-gallery - HERE
• 02/27/2018 - 5.0.1 - angular-modal-gallery - HERE
• 02/27/2018 - 5.0.0 - angular-modal-gallery - HERE
• 02/24/2018 - 5.0.0-rc.3 - angular-modal-gallery - HERE
• 02/24/2018 - 5.0.0-rc.2 - angular-modal-gallery - HERE
• 02/17/2018 - 5.0.0-rc.1 - angular-modal-gallery - HERE
• 02/10/2018 - 5.0.0-beta.2 - angular-modal-gallery - HERE
• 01/24/2018 - 5.0.0-beta.1 - angular-modal-gallery - HERE
• 01/14/2018 - 5.0.0-alpha.5 - angular-modal-gallery - HERE
• 12/24/2017 - 5.0.0-alpha.4 - angular-modal-gallery - HERE
• 12/09/2017 - 5.0.0-alpha.3 - angular-modal-gallery - HERE
• 12/03/2017 - 5.0.0-alpha.2 - angular-modal-gallery - HERE
• 12/03/2017 - 5.0.0-alpha.1 - angular-modal-gallery - HERE
• 11/05/2017 - 4.0.1 - angular-modal-gallery - HERE
• 11/05/2017 - 4.0.0 - angular-modal-gallery - HERE
• 10/11/2017 - 3.3.5 - angular-modal-gallery - HERE
• ...
• 03/20/2017 - 3.0.0 - angular-modal-gallery - HERE
• ...
• 01/29/2017 - 2.0.0 - angular-modal-gallery - HERE

FAQS

1. Question: I have this error: Cannot find name 'MousetrapInstance'. What can I do?
   Answer: Simply run npm i --save-dev @types/mousetrap
2. Question: I have this error: Error: No provider for KeyboardService. What can I do?
   Answer: You forgot to add .forRoot(), so KeyboardService will be never available as a service. Please read section "Installation" HERE. This is a common design pattern for Angular libraries. For more info check also this issue.
3. Question: How can I remove images using DELETE button without issues?
   Answer: You cannot change the input image array. Instead, you should reassign it with a newer array without the deleted element. In other words, you must think in a functional way, without changing the input array of images. For more information check this official demo HERE.

Contributing

Check CONTRIBUTING.md in this repository

Also, if you want to generate the internal library documentation, run npm run docs and open ./docs/typedoc/index.html.

A big thank you to

all authors of icons used in this library:

• Icons made by Smartline from www.flaticon.com is licensed by CC 3.0 BY
• Icons made by Dave Gandy from www.flaticon.com is licensed by CC 3.0 BY
• Icons made by Freepik from www.flaticon.com is licensed by CC 3.0 BY
• Icons made by Those Icons from www.flaticon.com is licensed by CC 3.0 BY
• Icons made by Gregor Cresnar from www.flaticon.com is licensed by CC 3.0 BY
• Icons made by Smashicons from www.flaticon.com is licensed by CC 3.0 BY

all authors of spinners used in this library:

• Luke Haas (@lukehaas) - lukehaas/css-loaders
• Martin van Driel (@martinvd) - martinvd example on codepen.io
• Devilish Alchemist - devilishalchemist example on codepen.io
• Nikhil Krishnan - nikhil8krishnan example on codepen.io
• Anastasiya Kuligina - Anastasiya Kuligina example on codepen.io

License

The MIT License (MIT)

Copyright (c) 2017-2018 Stefano Cappa (Ks89)

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 NON INFRINGEMENT. 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.

If you like my projects you can do a free donation here

FOSSA report

Created by Stefano Cappa

Changelog

6.0.0

Features

• id is now a mandatory input parameter (BREAKING CHANGE)
• new package name @ks89/angular-modal-gallery (to install use npm i --save @ks89/angular-modal-gallery@next) (BREAKING CHANGE)
• Support Angular Package Format specification v5 (BREAKING CHANGE)
• Remove Angular 4 support (BREAKING CHANGE)
• Add close method inside gallery.service (requested by @Enngage)
• Force side previews at the margins, because they was moving with current images of different sizes (rectangular) (requested by @Enngage) (BREAKING CHANGE)
• Add workaround to support SystemJS + AOT #142 - requested by @mlc-mlapis (BREAKING CHANGE FOR ALL SYSTEMJS USERS)
• Add full-screen button in FULL strategy
• Move loadingConfig, description and downloadble into CurrentImageConfig (BREAKING CHANGE)

Bugfixes

• Fix an issue when strictNullChecks and AOT are enabled together

Internal library changes

• Force AOT builds with all strict options in ng-packagr tsconfig file used in npm run build:lib
• Migrate to nwrl/nx 0.9.0
• Migrate to ng-packagr 2

Testing

• Update full-screen button
• Update for the new loadingConfig api
• Update unit testing with the new CurrentImageConfig

Chores

• New 6.0.0 logo red/orange

Docs

• Release the new documentation website 6.0.0

Demos

• Add an example with Angular 5.x.x and angular-cli 1.7.x
• Update all examples to the new APIs
• Remove webpack example