Angular Image Slider with Lightbox

An Angular responsive image slider with lightbox popup. Also support youtube and mp4 video urls. It is leazy loading and heigly optimized with standalone component.

(Compatible with Angular Version: 17)

Features!

• Responsive (support images width and height in both % and px)
• captures swipes from phones and tablets
• Compatible with Angular Universal
• Image lightbox popup
• captures keyboard next/previous arrow key event for lightbox image move
• Support Images (jpeg, jpg, gif, png and Base64-String), Youtube url and MP4 video (url and Base64-String)
• Handling runtime image arraylist changes

Installation

Install rm-image-slider with npm amd yarn

  npm: npm install rm-image-slider--save 

  yarn: yarn add rm-image-slider

Setup :

Import module in your component:

import { RmImageSliderComponent, ImageObject } from 'rm-image-slider';
...
@Component({
  selector: '',
  standalone: true,
  imports: [RmImageSliderComponent],
  templateUrl: '',
  styleUrl: '',
})

Add component in your template file.

<rm-image-slider [images]="imageObject" #nav></rm-image-slider>

ImageObject format

imageObject: Array<ImageObject> = [{
        image: 'assets/img/slider/1.jpg',
        thumbImage: 'assets/img/slider/1_min.jpeg',
        alt: 'alt of image',
        title: 'title of image',
        index: 1
    }, {
        image: '.../iOe/xHHf4nf8AE75h3j1x64ZmZ//Z==', // Support base64 image
        thumbImage: '.../iOe/xHHf4nf8AE75h3j1x64ZmZ//Z==', // Support base64 image
        title: 'Image title', //Optional: You can use this key if want to show image with title
        alt: 'Image alt', //Optional: You can use this key if want to show image with alt
        order: 1, //Optional: if you pass this key then slider images will be arrange according @input: slideOrderType
        index: 2
    }
];

Image, Youtube and MP4 url's object format

imageObject: Array<ImageObject> = [{
       video: 'https://youtu.be/....' // Youtube url
        index: 1
   },
	{
		video: 'assets/video/********.mp4', // MP4 Video url
    index: 2
	},
	{
		video: 'assets/video/movie2.mp4', 
    posterImage: 'assets/img/slider/2_min.jpeg', //Optional: You can use this key if you want to show video poster image in slider
    title: 'Image title',
    index: 3
   },
	{
		image: 'assets/img/slider/1.jpg',
    thumbImage: 'assets/img/slider/1_min.jpeg',
    alt: 'Image alt',
    index: 4
	}
   ...
];

API Reference (optional) :

| Name | Type | Data Type | Description | Default | | ------------------ | ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | | infinite | @Input | boolean | Infinite sliding images if value is true. | false | | imagePopup | @Input | boolean | Enable image lightBox popup option on slider image click. | true | | animationSpeed | @Input | number | By this user can set slider animation speed. Minimum value is 0.1 second and Maximum value is 5 second. | 1 | | slideImage | @Input | number | Set how many images will move on left/right arrow click. | 1 | | imageSize | @Input | object | Set slider images width, height and space. space is use for set space between slider images. Pass object like {width: '400px', height: '300px', space: 4} or you can pass value in percentage {width: '20%', height: '20%'} OR set only space {space: 4} | {width: 205, height: 200, space: 3} | | manageImageRatio | @Input | boolean | Show images with aspect ratio if value is true and set imageSize width and height on parent div | false | | autoSlide | @Input | number/boolean/object | Auto slide images according provided time interval. Option will work only if infinite option is true. For number data type minimum value is 1 second and Maximum value is 5 second. By object data type you can prevent auto slide stop behaviour on mouse hover event. {interval: 2, stopOnHover: false} | 0 | | showArrow | @Input | boolean | Hide/Show slider arrow buttons | true | | arrowKeyMove | @Input | boolean | Disable slider and popup image left/right move on arrow key press event, if value is false | true | | videoAutoPlay | @Input | boolean | Auto play popup video | false | | showVideoControls | @Input | boolean | Hide video control if value is false | true | | direction | @Input | string | Set text direction. You can pass rtl / ltr / auto | ltr | | slideOrderType | @Input | string | Arrange slider images in Ascending order by ASC and in Descending order by DESC. order key must be exist with image object. | ASC | | lazyLoading | @Input | boolean | Lazy load images and Iframe if true. | false | | defaultActiveImage | @Input | number | Set image as selected on load. | null | | imageClick | @Output | n/a | Executes when click event on slider image. Return image index. | n/a | | arrowClick | @Output | n/a | Executes when click on slider left/right arrow. Returns current event name and next/previous button disabled status. | n/a | | lightboxClose | @Output | n/a | Executes when lightbox close. | n/a | | lightboxArrowClick | @Output | n/a | Executes when click on lightbox next/previous arrow. | n/a |

Add custom navigation button

import { RmImageSliderComponent } from 'rm-image-slider';

@Component({
    selector: 'sample',
     standalone: true,
     imports: [RmImageSliderComponent],
        template:`
        <rm-image-slider [images]="imageObject" #nav>
        </rm-image-slider>
        <button (click)="prevImageClick()">Prev</button>
        <button (click)="nextImageClick()">Next</button>
        `
})
class Sample {
    @ViewChild('nav') slider: RmImageSliderComponent;
    imageObject = [{...}]

    prevImageClick() {
        this.slider.prev();
    }

    nextImageClick() {
        this.slider.next();
    }
}

Issues

If you identify any errors in this component, 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 services

Are you interested in this library but lacks features? Write to the author, he can do it for you.

Credits

The library is inspired by one other library.

Author

Rajat Malik

• github/malikrajat