Image Slider/ carousel

Advanced, customizable, Optimized ,Minimal, light-weight and fully customizable pure angular component for carousel.

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.

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

1
2  npm: npm install rm-image-slider--save 
3
4  yarn: yarn add rm-image-slider
5

Setup :

Import module in your component:

1import { RmImageSliderComponent, ImageObject } from 'rm-image-slider';
2...
3@Component({
4  selector: '',
5  standalone: true,
6  imports: [RmImageSliderComponent],
7  templateUrl: '',
8  styleUrl: '',
9})
10

Add component in your template file.

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

ImageObject format

1imageObject: Array<ImageObject> = [{

2        image: 'assets/img/slider/1.jpg',

3        thumbImage: 'assets/img/slider/1_min.jpeg',

4        alt: 'alt of image',

5        title: 'title of image',

6        index: 1
7    }, {

8        image: '.../iOe/xHHf4nf8AE75h3j1x64ZmZ//Z==', // Support base64 image

9        thumbImage: '.../iOe/xHHf4nf8AE75h3j1x64ZmZ//Z==', // Support base64 image

10        title: 'Image title', //Optional: You can use this key if want to show image with title

11        alt: 'Image alt', //Optional: You can use this key if want to show image with alt

12        order: 1, //Optional: if you pass this key then slider images will be arrange according @input: slideOrderType

13        index: 2
14    }
15];

Image, Youtube and MP4 url's object format

1imageObject: Array<ImageObject> = [{

2       video: 'https://youtu.be/....' // Youtube url

3        index: 1
4   },
5	{

6		video: 'assets/video/********.mp4', // MP4 Video url

7    index: 2
8	},
9	{

10		video: 'assets/video/movie2.mp4', 

11    posterImage: 'assets/img/slider/2_min.jpeg', //Optional: You can use this key if you want to show video poster image in slider

12    title: 'Image title',

13    index: 3
14   },
15	{

16		image: 'assets/img/slider/1.jpg',

17    thumbImage: 'assets/img/slider/1_min.jpeg',

18    alt: 'Image alt',

19    index: 4
20	}
21   ...
22];

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

1import { RmImageSliderComponent } from 'rm-image-slider';
2
3@Component({
4    selector: 'sample',
5     standalone: true,
6     imports: [RmImageSliderComponent],
7        template:`
8        <rm-image-slider [images]="imageObject" #nav>
9        </rm-image-slider>
10        <button (click)="prevImageClick()">Prev</button>
11        <button (click)="nextImageClick()">Next</button>
12        `
13})
14class Sample {
15    @ViewChild('nav') slider: RmImageSliderComponent;
16    imageObject = [{...}]
17
18    prevImageClick() {
19        this.slider.prev();
20    }
21
22    nextImageClick() {
23        this.slider.next();
24    }
25}

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