Skip to content
Switch branches/tags
Go to file
2 contributors

Users who have contributed to this file

@BenjaminBrandmeier @victooor
101 lines (65 sloc) 3.53 KB

Angular 2 Image Gallery

Build Status BrowserStack Status npm version npm downloads

----> compatible with Angular 8+ <----

Responsive image gallery designed for high resolution images.

The project consists of a gallery, a viewer and a script for image preparation.

Before using the gallery, you have to process all of your images that will be part of your gallery with the convert script. The processed images will be stored to your applications assets or, if you wish, at a remote location. During runtime everything runs client-side and there is no separate server-side communication involved. The viewer takes care an optimal image quality is served based on the screen resolution.


How to use the gallery in your project


Install graphicsmagick:

Embed in your project

1. Install angular2-image-gallery

npm install angular2-image-gallery --save
npm install hammerjs --save

2. Import angular2-image-gallery in your Angular module

imports: [

3. Add hammer.js for support of mobile devices

Add the following line to your main.ts file:

import 'hammerjs';

4. Run convert script

node node_modules/angular2-image-gallery/convert.js <path/to/your/images>

Add a flag to define the order of the images inside the gallery

-n sort by file name (default)

-d sort chronologically by the original creation time (e.g. for coverages of a wedding)

-c sort by primary image color

Additional optional parameter to support multiple galleries. Add it if you want to put your images into a separate gallery.


5. Embed gallery in your template


All parameters are optional. You may play around on the demo site to find out what parameters suit your needs.

The viewerChange event notifies you when the viewer component gets opened or closed.

That's it, start your application and have a look!

Fetching images from an external data source

If you'd like to know how you could fetch your images from an external data source CLICK HERE

I don't want to use the convert script and provide my own metadata JSON

This is possible, but not the intent of this project. Please CLICK HERE

Currently used tools

  • Angular 7.0.0
  • NodeJS 8.11.2
  • graphicsmagick


If the conversion process fails, make sure you have enough swap space provided.

If you experience any other issues, please raise an issue on GitHub.