ng-gallery

Angular Image Gallery

Angular image gallery simplifies the process of creating beautiful image gallery for the web and mobile devices.

Installation

Install it with npm

$ npm install --save @angular/cdk ngx-gallery

This plugin depends on Angular CDK for the lightbox feature, you don't need to import anything from the CDK, just make sure that it is installed in the project.

SystemJS

If you are using SystemJS, you should also adjust your configuration to point to the UMD bundle.

In your systemjs config file, map needs to tell the System loader where to look for ng-gallery:

map: {
  'ng-gallery': 'node_modules/ng-gallery/bundles/ng-gallery.umd.js',
}

Here is a stackblitz

Usage

1. Import GalleryModule.forRoot(...) in the root module

Import GalleryModule and set the gallery configuration in your root module

  import { BrowserAnimationsModule } from  '@angular/platform-browser/animations';
  import { GalleryModule } from 'ng-gallery';
  
  export const config : GalleryConfig = {
    // ...
  }
  
  @NgModule({
   imports: [
      // ...
      BrowserAnimationsModule,
      GalleryModule.forRoot(config)
   ]
  })

1. Load images into the gallery

Add images into the gallery by using the service Gallery.load(...), see basic example.

Alternatively, you can automatically add images using the directive [gallerize], see auto-detect example.

After that use will be able to use <gallery></gallery> component to display the gallery in the template.

Or if you want to open the gallery in an overlay, use the service Gallery.open(), see gallery lightbox example.

Load image

Use the service Gallery to load images

import { Gallery, GalleryItem } from 'ng-gallery';

export class AppComponent implements OnInit {
  
  constructor(public gallery: Gallery) { }
  
  ngOnInit() {
    const images: GalleryItem[] = [
      {
        src: 'assets/clouds.jpg',
        thumbnail: 'assets/clouds.jpg',
        text: 'Sky & Clouds'
      },
      // ...
    ];
    
    this.gallery.load(images);
  }
}

Auto-detect

The directive [gallerize] will automatically detect all images inside the host element and hook them with the gallery lightbox

<div gallerize>
  <img src="assets/img/img3.jpg" alt="Spring">
  <img src="assets/img/img4.jpg" alt="Fire">
  <img src="assets/img/img5.jpg" alt="Peacock">
</div>

You can also detect images using their class, [gallerize]="'class-name'"

<div gallerize="cars">
  <img class="cars" src="assets/img/img3.jpg" alt="BMW">
  <img class="cars" src="assets/img/img4.jpg" alt="Toyota">
  <img class="bikes" src="assets/img/img5.jpg" alt="S800">
</div>

Gesture Support (optional)

Gallery Module relies on HammerJS for gestures, make sure it is loaded into the application.

You can add HammerJS to your application via npm, a CDN (such as the Google CDN), or served directly from your app.

To install via npm, use the following command:

$ npm install --save hammer.js

After installing, import it on your app's root module

import 'hammerjs';

Support

Issues

If you identify any errors in this module, or have an idea for an improvement, please open an issue. I am excited to see what the community thinks of this project, and I would love your input!

Author

Murhaf Sousli

• github/murhafsousli
• twitter/murhafsousli

Changelog

1.0.0-beta.8

• fix(keyboard listener in lightbox) closes #24, #33.
• refactor(Gallerize directive) Use MutationObserver instead of DOMSubtreeModified, closes #26.
• fix(Universal support), closes #9.
• fix Angular 5 warning, closes #21.
• Improve gallery lightbox, closes #20.
• Improve gallery lightbox slide animation, closes #8.
• Use Angular CDK for the gallery lightbox.
• refactor(GalleryConfig)
• Remove image transition animation option because it was not implemented properly.