rm-image-slider 17.3.0 → 18.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,7 +1,18 @@
1
+ <a href="https://github.com/malikrajat/rm-image-slider">
2
+
3
+ <h1 align="center">Image Slider/ carousel</h1>
4
+
5
+ <p align="center">Advanced, customizable, Optimized ,Minimal, light-weight and fully customizable pure angular component for carousel.</p>
6
+
7
+ </a>
8
+ [![npm](https://img.shields.io/npm/v/ngx-bar-rating.svg)](https://www.npmjs.com/package/rm-image-slider)
9
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/malikrajat/rm-image-slider)
10
+
11
+ __
1
12
  # Angular Image Slider with Lightbox
2
13
 
3
14
  An Angular responsive image slider with lightbox popup.
4
- Also support youtube and mp4 video urls.
15
+ Also support youtube and mp4 video urls. It is leazy loading and heigly optimized with standalone component.
5
16
 
6
17
  (Compatible with Angular Version: 17)
7
18
 
@@ -17,14 +28,22 @@ Also support youtube and mp4 video urls.
17
28
 
18
29
  # Installation
19
30
 
20
- `npm install rm-image-slider --save`
31
+ Install rm-image-slider with npm amd yarn
32
+
33
+ ```bash
34
+
35
+ npm: npm install rm-image-slider--save
36
+
37
+ yarn: yarn add rm-image-slider
38
+
39
+ ```
21
40
 
22
41
  # Setup :
23
42
 
24
43
  **Import module in your component:**
25
44
 
26
45
  ```typescript
27
- import { RmImageSliderComponent } from 'rm-image-slider';
46
+ import { RmImageSliderComponent, ImageObject } from 'rm-image-slider';
28
47
  ...
29
48
  @Component({
30
49
  selector: '',
@@ -45,17 +64,19 @@ import { RmImageSliderComponent } from 'rm-image-slider';
45
64
  **ImageObject format**
46
65
 
47
66
  ```js
48
- imageObject: Array<object> = [{
67
+ imageObject: Array<ImageObject> = [{
49
68
  image: 'assets/img/slider/1.jpg',
50
69
  thumbImage: 'assets/img/slider/1_min.jpeg',
51
70
  alt: 'alt of image',
52
- title: 'title of image'
71
+ title: 'title of image',
72
+ index: 1
53
73
  }, {
54
74
  image: '.../iOe/xHHf4nf8AE75h3j1x64ZmZ//Z==', // Support base64 image
55
75
  thumbImage: '.../iOe/xHHf4nf8AE75h3j1x64ZmZ//Z==', // Support base64 image
56
76
  title: 'Image title', //Optional: You can use this key if want to show image with title
57
77
  alt: 'Image alt', //Optional: You can use this key if want to show image with alt
58
- order: 1 //Optional: if you pass this key then slider images will be arrange according @input: slideOrderType
78
+ order: 1, //Optional: if you pass this key then slider images will be arrange according @input: slideOrderType
79
+ index: 2
59
80
  }
60
81
  ];
61
82
  ```
@@ -63,21 +84,25 @@ imageObject: Array<object> = [{
63
84
  **Image, Youtube and MP4 url's object format**
64
85
 
65
86
  ```js
66
- imageObject: Array<object> = [{
87
+ imageObject: Array<ImageObject> = [{
67
88
  video: 'https://youtu.be/....' // Youtube url
89
+ index: 1
68
90
  },
69
91
  {
70
92
  video: 'assets/video/********.mp4', // MP4 Video url
93
+ index: 2
71
94
  },
72
95
  {
73
- video: 'assets/video/movie2.mp4',
74
- posterImage: 'assets/img/slider/2_min.jpeg', //Optional: You can use this key if you want to show video poster image in slider
75
- title: 'Image title'
96
+ video: 'assets/video/movie2.mp4',
97
+ posterImage: 'assets/img/slider/2_min.jpeg', //Optional: You can use this key if you want to show video poster image in slider
98
+ title: 'Image title',
99
+ index: 3
76
100
  },
77
101
  {
78
102
  image: 'assets/img/slider/1.jpg',
79
- thumbImage: 'assets/img/slider/1_min.jpeg',
80
- alt: 'Image alt'
103
+ thumbImage: 'assets/img/slider/1_min.jpeg',
104
+ alt: 'Image alt',
105
+ index: 4
81
106
  }
82
107
  ...
83
108
  ];
@@ -114,6 +139,8 @@ import { RmImageSliderComponent } from 'rm-image-slider';
114
139
 
115
140
  @Component({
116
141
  selector: 'sample',
142
+ standalone: true,
143
+ imports: [RmImageSliderComponent],
117
144
  template:`
118
145
  <rm-image-slider [images]="imageObject" #nav>
119
146
  </rm-image-slider>
@@ -134,3 +161,26 @@ class Sample {
134
161
  }
135
162
  }
136
163
  ```
164
+ <a name="issues"/>
165
+
166
+ ## Issues
167
+
168
+ If you identify any errors in this component, or have an idea for an improvement, please open
169
+ an [issue](https://github.com/malikrajat/rm-image-slider/issues). I am excited to see what the community thinks of this
170
+ project, and I would love your input!
171
+
172
+ ## Author services
173
+
174
+ Are you interested in this library but lacks features? Write to the author, he can do it for you.
175
+
176
+ ## Credits
177
+
178
+ The library is inspired by one other library.
179
+
180
+
181
+ <a name="author"/>
182
+
183
+ ## Author
184
+
185
+ **Rajat Malik**
186
+ - [github/malikrajat](https://github.com/malikrajat)
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vcHJvamVjdHMvcm0taW1hZ2Utc2xpZGVyL3NyYy9saWIvaW50ZXJmYWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgaW50ZXJmYWNlIEltYWdlT2JqZWN0IHtcclxuICBpbWFnZT86IHN0cmluZztcclxuICB0aHVtYkltYWdlPzogc3RyaW5nO1xyXG4gIGFsdD86IHN0cmluZztcclxuICB0aXRsZT86IHN0cmluZztcclxuICBvcmRlcj86IG51bWJlcjtcclxuICBpbmRleDogbnVtYmVyO1xyXG4gIHBvc3RlckltYWdlPzogc3RyaW5nO1xyXG4gIHZpZGVvPzogc3RyaW5nO1xyXG59XHJcbiJdfQ==