Angular Universal carousel
npm install kbk-ngu-libraryAngular Universal carousel
Note: This carousel doesn't include any css. go and customize css for buttons, items except ngucarousel and ngucarousel-inner
for ChangeLog go to releases
Demo available Here
npm install @ngu/carousel --save
Include CarouselModule in your app module:
``javascript
import { NguCarouselModule } from '@ngu/carousel';
@NgModule({
imports: [NguCarouselModule]
})
export class AppModule {}
`
Now ngu-carousel supports touch with the help of hammerjs
npm install hammerjs --save
Import hammerjs in polyfills.ts file
`javascript`
import 'hammerjs';
Then use in your component:
`javascript
import { Component } from '@angular/core';
import { NguCarousel } from '@ngu/carousel';
@Component({
selector: 'sample',
template:
(carouselLoad)="myfunc($event)">
....
....
....
,
})
export class SampleComponent implements OnInit {
public carouselOne: NguCarousel;
ngOnInit() {
this.carouselOne = {
grid: {xs: 1, sm: 1, md: 1, lg: 1, all: 0},
slide: 1,
speed: 400,
interval: 4000,
point: {
visible: true
},
load: 2,
touch: true,
loop: true,
custom: 'banner'
}
}
public myfunc(event: Event) {
// carouselLoad will trigger this funnction when your load value reaches
// it is helps to load the data by parts to increase the performance of the app
// must use feature to all carousel
}
}
`
`javascript
export class NguCarouselStore {
type: string;
deviceType: DeviceType;
token: string;
items: number;
load: number;
deviceWidth: number;
carouselWidth: number;
itemWidth: number;
visibleItems: ItemsControl;
slideItems: number;
itemWidthPer: number;
itemLength: number;
currentSlide: number;
easing: string;
speed: number;
transform: Transfrom;
loop: boolean;
dexVal: number;
touchTransform: number;
touch: Touch;
isEnd: boolean;
isFirst: boolean;
isLast: boolean;
RTL: boolean;
vertical: Vertical;
}
export type DeviceType = 'xs' | 'sm' | 'md' | 'lg' | 'all';
export class ItemsControl {
start: number;
end: number;
}
export class Vertical {
enabled: boolean;
height: number;
}
export class Touch {
active?: boolean;
swipe: string;
velocity: number;
}
export class NguCarousel {
grid: Transfrom;
slide?: number;
speed?: number;
interval?: number;
animation?: Animate;
point?: Point;
type?: string;
load?: number;
custom?: Custom;
loop?: boolean;
touch?: boolean;
easing?: string;
RTL?: boolean;
vertical?: Vertical;
}
export class Grid {
xs: number;
sm: number;
md: number;
lg: number;
all: number;
}
export interface Point {
visible: boolean;
hideOnSingleSlide?: boolean;
pointStyles?: string;
}
export type Custom = 'banner';
export type Animate = 'lazy';
`
| Command | Type | Required | Description |
| ------------------------- | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| grid | Object | Yes | xs - mobile, sm - tablet, md - desktop, lg - large desktops, all - fixed width (When you use all make others 0 and vise versa) |slide
| | number | optional | It is used to slide the number items on click |speed
| | milli seconds | optional | It is used for time taken to slide the number items |interval
| | milli seconds | optional | It is used to make carousel auto slide with given value. interval defines the interval between slides |load
| | number | optional | is used to load the items similar to pagination. the carousel will tigger the carouslLoad function to load another set of items. it will help you to improve the performance of the app.(carouselLoad)="myfunc($event)" |point.visible
| | boolean | optional | It is used to indicate no. of slides and also shows the current active slide. |point.pointStyle
| | string | optional | It is used to customize the point indicator. make sure your check the guide. |point.hideOnSingleSlide
| | boolean | optional | It is used to hide the point indicator when slide is less than one. |touch
| | boolean | optional | It is used to active touch support to the carousel. |easing
| | string | optional | It is used to define the easing style of the carousel. Only define the ease name without any timing like ease,ease-in |loop
| | boolean | optional | It is used to loop the ngu-item | ngu-tile. It must be true for interval |animation
| | string | optional | It is used to animate the sliding items. currently it only supports lazy. more coming soon and also with custom css animation option |custom
| | string | optional | It is you to define the purpose of the carousel. currently it only supports banner. more coming soon and also with custom css animation option |RTL
| | boolean | optional | This option enable the rtl direction and act as rtl. By default it is ltr |vertical.enabled
| | boolean | optional | This option enable the vertical direction |vertical.height
| | boolean | optional | This option is used to set the height of the carousel |
`html`
This is HTML I'm using in the carousel. Add your own css according to this elements in pointStyles. check below guide for more details.
`html`
(initData)="initDataFn($event)"
(onMove)="onmoveFn($event)"
(carouselLoad)="loadItemsFn()">
* inputs is an Input and It accepts NguCarousel.initData
* is an Output which triggered on carousel init and it emits token to exchange with service to contol the carousel.onMove
* is an Output which triggered on every slide before start and it will emit $event as NguCarouselStore object.carouselLoad
* is an Output which triggered when slide reaches the end on items based on inputs load.
`javascript`
import { NguCarouselService } from '@ngu/carousel';
This carousel Service supports:
* reset(token) - This function will reset the carouselmoveToSlide(token, index, animate)
* - This function is used to move to index with animation control.
`javascript
import { Component } from '@angular/core';
import { NguCarousel, NguCarouselStore } from '@ngu/carousel';
@Component({
selector: 'app-carousel',
template:
(onMove)="onmoveFn($event)">
1
2
3
,
styles: [
.bannerStyle h1 {
background-color: #ccc;
min-height: 300px;
text-align: center;
line-height: 300px;
}
.leftRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
left: 0;
}
.rightRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
right: 0;
}
]
})
export class Sample implements OnInit {
ngOnInit() {
this.carouselBanner = {
grid: { xs: 1, sm: 1, md: 1, lg: 1, all: 0 },
slide: 1,
speed: 400,
interval: 4000,
point: {
visible: true,
pointStyles:
.ngucarouselPoint {
list-style-type: none;
text-align: center;
padding: 12px;
margin: 0;
white-space: nowrap;
overflow: auto;
position: absolute;
width: 100%;
bottom: 20px;
left: 0;
box-sizing: border-box;
}
.ngucarouselPoint li {
display: inline-block;
border-radius: 999px;
background: rgba(255, 255, 255, 0.55);
padding: 5px;
margin: 0 3px;
transition: .4s ease all;
}
.ngucarouselPoint li.active {
background: white;
width: 10px;
}
},
load: 2,
loop: true,
touch: true
};
}
/ It will be triggered on every slide/
onmoveFn(data: NguCarouselStore) {
console.log(data);
}
}
`
`javascript
import { Component } from '@angular/core';
import { NguCarousel, NguCarouselStore } from '@ngu/carousel';
@Component({
selector: 'app-carousel',
template:
(onMove)="onmoveFn($event)">
1
2
3
,
styles: [
.bannerStyle h1 {
background-color: #ccc;
min-height: 300px;
text-align: center;
line-height: 300px;
}
.leftRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
left: 0;
}
.rightRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
right: 0;
}
]
})
export class Sample implements OnInit {
ngOnInit() {
this.carouselBanner = {
grid: { xs: 1, sm: 1, md: 1, lg: 1, all: 0 },
slide: 1,
speed: 400,
interval: 4000,
point: {
visible: true,
pointStyles:
.ngucarouselPoint {
list-style-type: none;
text-align: center;
padding: 12px;
margin: 0;
white-space: nowrap;
overflow: auto;
position: absolute;
width: 100%;
bottom: 20px;
left: 0;
box-sizing: border-box;
}
.ngucarouselPoint li {
display: inline-block;
border-radius: 999px;
background: rgba(255, 255, 255, 0.55);
padding: 5px;
margin: 0 3px;
transition: .4s ease all;
}
.ngucarouselPoint li.active {
background: white;
width: 10px;
}
},
load: 2,
loop: true,
touch: true, // touch is not currently in active for vertical carousel, will enable it in future build
vertical {
enabled: true,
height: 400
}
};
}
/ It will be triggered on every slide/
onmoveFn(data: NguCarouselStore) {
console.log(data);
}
}
`
`javascript
import { Component } from '@angular/core';
import { NguCarousel, NguCarouselStore, NguCarouselService } from '@ngu/carousel';
@Component({
selector: 'app-carousel',
template:
(initData)="initDataFn($event)"
(carouselLoad)="carouselTileLoad($event)">
{{Tile + 1}}
,
styles: [
h1{
min-height: 200px;
background-color: #ccc;
text-align: center;
line-height: 200px;
}
.leftRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
left: 0;
}
.rightRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
right: 0;
}
]
})
export class Sample implements OnInit {
private carouselToken: string;
public carouselTileItems: Array
public carouselTile: NguCarousel;
constructor(private carousel: NguCarouselService) { }
ngOnInit(){
this.carouselTileItems = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
this.carouselTile = {
grid: {xs: 2, sm: 3, md: 3, lg: 5, all: 0},
slide: 2,
speed: 400,
animation: 'lazy',
point: {
visible: true
},
load: 2,
touch: true,
easing: 'ease'
}
}
initDataFn(key: NguCarouselStore) {
this.carouselToken = key.token;
}
resetFn() {
this.carousel.reset(this.carouselToken);
}
moveToSlide() {
this.carousel.moveToSlide(this.carouselToken, 2, false);
}
public carouselTileLoad(evt: any) {
const len = this.carouselTileItems.length
if (len <= 30) {
for (let i = len; i < len + 10; i++) {
this.carouselTileItems.push(i);
}
}
}
// carouselLoad will trigger this funnction when your load value reaches
// it is helps to load the data by parts to increase the performance of the app
// must use feature to all carousel
}
`
`javascript
import { Component } from '@angular/core';
import { NguCarousel } from '@ngu/carousel';
@Component({
selector: 'app-carousel',
template:
(carouselLoad)="carouselTileLoad($event)">
{{Tile + 1}}
,
styles: [
h1{
min-height: 200px;
background-color: #ccc;
text-align: center;
line-height: 200px;
}
.leftRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
left: 0;
}
.rightRs {
position: absolute;
margin: auto;
top: 0;
bottom: 0;
width: 50px;
height: 50px;
box-shadow: 1px 2px 10px -1px rgba(0, 0, 0, .3);
border-radius: 999px;
right: 0;
}
]
})
export class Sample implements OnInit {
public carouselTileItems: Array
public carouselTile: NguCarousel;
ngOnInit(){
this.carouselTileItems = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
this.carouselTile = {
grid: {xs: 2, sm: 3, md: 3, lg: 5, all: 0},
slide: 2,
speed: 400,
animation: 'lazy',
point: {
visible: true,
pointStyles:
.ngucarouselPoint {
list-style-type: none;
text-align: center;
padding: 12px;
margin: 0;
white-space: nowrap;
overflow: auto;
box-sizing: border-box;
}
.ngucarouselPoint li {
display: inline-block;
border-radius: 50%;
border: 2px solid rgba(0, 0, 0, 0.55);
padding: 4px;
margin: 0 3px;
transition-timing-function: cubic-bezier(.17, .67, .83, .67);
transition: .4s;
}
.ngucarouselPoint li.active {
background: #6b6b6b;
transform: scale(1.2);
}
},
load: 2,
touch: true,
easing: 'ease'
}
}
public carouselTileLoad(evt: any) {
const len = this.carouselTileItems.length
if (len <= 30) {
for (let i = len; i < len + 10; i++) {
this.carouselTileItems.push(i);
}
}
}
// carouselLoad will trigger this funnction when your load value reaches
// it is helps to load the data by parts to increase the performance of the app
// must use feature to all carousel
}
``
MIT license.