p-mohamed-elsawy / ngx-gallery

Ngx Gallery

Small, performant, responsive, dependency free, easy to use Angular 8+ gallery.

Showcase | Changelog

Installation

yarn add @daelmaak/ngx-gallery

Versioning

Gallery	Angular	Readme
3.x.x	>=16	here
2.x.x	>=13	2.1.0
<=1.x.x	>=8 <13	1.3.0

Usage

1. Import gallery into your component

import { GalleryComponent } from '@daelmaak/ngx-gallery';

@Component({
  standalone: true,
  imports: [GalleryComponent],
})
export class AppComponent {}

or into your module if you don't use standalone

import { GalleryComponent } from '@daelmaak/ngx-gallery';

@NgModule({
  imports: [GalleryComponent],
})
export class AppModule {}

2. Create an image

import { GalleryItem } from '@daelmaak/ngx-gallery';

@Component({...})
export class AppComponent {
  images: GalleryItem[] = [{ src: 'kitten1.jpg' }]
}

3. Render the gallery

<gallery [items]="images"></gallery>

Local development

yarn
yarn start # start demo app
yarn test