README.md

November 13, 2024 ยท View on GitHub

Ngx Gallery

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

codecov npm version

Showcase | Changelog

Installation

yarn add @daelmaak/ngx-gallery

Versioning

GalleryAngularReadme
3.x.x>=16here
2.x.x>=132.1.0
<=1.x.x>=8 <131.3.0

Usage

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' }]
}
<gallery [items]="images"></gallery>

Local development

yarn
yarn start # start demo app
yarn test