ngx-bootstrap
Version:
Angular Bootstrap
664 lines • 24.5 kB
JavaScript
/***
* pause (not yet supported) (?string='hover') - event group name which pauses
* the cycling of the carousel, if hover pauses on mouseenter and resumes on
* mouseleave keyboard (not yet supported) (?boolean=true) - if false
* carousel will not react to keyboard events
* note: swiping not yet supported
*/
/****
* Problems:
* 1) if we set an active slide via model changes, .active class remains on a
* current slide.
* 2) if we have only one slide, we shouldn't show prev/next nav buttons
* 3) if first or last slide is active and noWrap is true, there should be
* "disabled" class on the nav buttons.
* 4) default interval should be equal 5000
*/
import { Component, EventEmitter, Input, NgZone, Output } from '@angular/core';
import { isBs3, LinkedList } from 'ngx-bootstrap/utils';
import { CarouselConfig } from './carousel.config';
import { findLastIndex, chunkByNumber } from './utils';
export var Direction;
(function (Direction) {
Direction[Direction["UNKNOWN"] = 0] = "UNKNOWN";
Direction[Direction["NEXT"] = 1] = "NEXT";
Direction[Direction["PREV"] = 2] = "PREV";
})(Direction || (Direction = {}));
/**
* Base element to create carousel
*/
export class CarouselComponent {
constructor(config, ngZone) {
this.ngZone = ngZone;
/* If `true` — carousel will not cycle continuously and will have hard stops (prevent looping) */
this.noWrap = false;
/* If `true` — will disable pausing on carousel mouse hover */
this.noPause = false;
/* If `true` — carousel-indicators are visible */
this.showIndicators = true;
/* If `true` - autoplay will be stopped on focus */
this.pauseOnFocus = false;
/* If `true` - carousel indicators indicate slides chunks
works ONLY if singleSlideOffset = FALSE */
this.indicatorsByChunk = false;
/* If value more then 1 — carousel works in multilist mode */
this.itemsPerSlide = 1;
/* If `true` — carousel shifts by one element. By default carousel shifts by number
of visible elements (itemsPerSlide field) */
this.singleSlideOffset = false;
/** Turn on/off animation. Animation doesn't work for multilist carousel */
this.isAnimated = false;
/** Will be emitted when active slide has been changed. Part of two-way-bindable [(activeSlide)] property */
this.activeSlideChange = new EventEmitter(false);
/** Will be emitted when active slides has been changed in multilist mode */
this.slideRangeChange = new EventEmitter();
/* Index to start display slides from it */
this.startFromIndex = 0;
this._interval = 5000;
this._slides = new LinkedList();
this._currentVisibleSlidesIndex = 0;
this.isPlaying = false;
this.destroyed = false;
this.getActive = (slide) => slide.active;
this.makeSlidesConsistent = (slides) => {
slides.forEach((slide, index) => slide.item.order = index);
};
Object.assign(this, config);
}
/** Index of currently displayed slide(started for 0) */
set activeSlide(index) {
if (this.multilist) {
return;
}
if (this._slides.length && index !== this._currentActiveSlide) {
this._select(index);
}
}
get activeSlide() {
return this._currentActiveSlide || 0;
}
/**
* Delay of item cycling in milliseconds. If false, carousel won't cycle
* automatically.
*/
get interval() {
return this._interval;
}
set interval(value) {
this._interval = value;
this.restartTimer();
}
get slides() {
return this._slides.toArray();
}
get isBs4() {
return !isBs3();
}
ngAfterViewInit() {
setTimeout(() => {
if (this.singleSlideOffset) {
this.indicatorsByChunk = false;
}
if (this.multilist) {
this._chunkedSlides = chunkByNumber(this.mapSlidesAndIndexes(), this.itemsPerSlide);
this.selectInitialSlides();
}
}, 0);
}
ngOnDestroy() {
this.destroyed = true;
}
/**
* Adds new slide. If this slide is first in collection - set it as active
* and starts auto changing
* @param slide
*/
addSlide(slide) {
this._slides.add(slide);
if (this.multilist && this._slides.length <= this.itemsPerSlide) {
slide.active = true;
}
if (!this.multilist && this.isAnimated) {
slide.isAnimated = true;
}
if (!this.multilist && this._slides.length === 1) {
this._currentActiveSlide = undefined;
this.activeSlide = 0;
this.play();
}
if (this.multilist && this._slides.length > this.itemsPerSlide) {
this.play();
}
}
/**
* Removes specified slide. If this slide is active - will roll to another
* slide
* @param slide
*/
removeSlide(slide) {
const remIndex = this._slides.indexOf(slide);
if (this._currentActiveSlide === remIndex) {
// removing of active slide
let nextSlideIndex;
if (this._slides.length > 1) {
// if this slide last - will roll to first slide, if noWrap flag is
// FALSE or to previous, if noWrap is TRUE in case, if this slide in
// middle of collection, index of next slide is same to removed
nextSlideIndex = !this.isLast(remIndex)
? remIndex
: this.noWrap ? remIndex - 1 : 0;
}
this._slides.remove(remIndex);
// prevents exception with changing some value after checking
setTimeout(() => {
this._select(nextSlideIndex);
}, 0);
}
else {
this._slides.remove(remIndex);
const currentSlideIndex = this.getCurrentSlideIndex();
setTimeout(() => {
// after removing, need to actualize index of current active slide
this._currentActiveSlide = currentSlideIndex;
this.activeSlideChange.emit(this._currentActiveSlide);
}, 0);
}
}
nextSlideFromInterval(force = false) {
this.move(Direction.NEXT, force);
}
/**
* Rolling to next slide
* @param force: {boolean} if true - will ignore noWrap flag
*/
nextSlide(force = false) {
if (this.isPlaying) {
this.restartTimer();
}
this.move(Direction.NEXT, force);
}
/**
* Rolling to previous slide
* @param force: {boolean} if true - will ignore noWrap flag
*/
previousSlide(force = false) {
if (this.isPlaying) {
this.restartTimer();
}
this.move(Direction.PREV, force);
}
getFirstVisibleIndex() {
return this.slides.findIndex(this.getActive);
}
getLastVisibleIndex() {
return findLastIndex(this.slides, this.getActive);
}
move(direction, force = false) {
const firstVisibleIndex = this.getFirstVisibleIndex();
const lastVisibleIndex = this.getLastVisibleIndex();
if (this.noWrap) {
if (direction === Direction.NEXT &&
this.isLast(lastVisibleIndex) ||
direction === Direction.PREV &&
firstVisibleIndex === 0) {
return;
}
}
if (!this.multilist) {
this.activeSlide = this.findNextSlideIndex(direction, force) || 0;
}
else {
this.moveMultilist(direction);
}
}
/**
* Swith slides by enter, space and arrows keys
* @internal
*/
keydownPress(event) {
if (event.keyCode === 13 || event.key === 'Enter' || event.keyCode === 32 || event.key === 'Space') {
this.nextSlide();
event.preventDefault();
return;
}
if (event.keyCode === 37 || event.key === 'LeftArrow') {
this.previousSlide();
return;
}
if (event.keyCode === 39 || event.key === 'RightArrow') {
this.nextSlide();
return;
}
}
/**
* Play on mouse leave
* @internal
*/
onMouseLeave() {
if (!this.pauseOnFocus) {
this.play();
}
}
/**
* Play on mouse up
* @internal
*/
onMouseUp() {
if (!this.pauseOnFocus) {
this.play();
}
}
/**
* When slides on focus autoplay is stopped(optional)
* @internal
*/
pauseFocusIn() {
if (this.pauseOnFocus) {
this.isPlaying = false;
this.resetTimer();
}
}
/**
* When slides out of focus autoplay is started
* @internal
*/
pauseFocusOut() {
this.play();
}
/**
* Rolling to specified slide
* @param index: {number} index of slide, which must be shown
*/
selectSlide(index) {
if (this.isPlaying) {
this.restartTimer();
}
if (!this.multilist) {
this.activeSlide = this.indicatorsByChunk ? index * this.itemsPerSlide : index;
}
else {
this.selectSlideRange(this.indicatorsByChunk ? index * this.itemsPerSlide : index);
}
}
/**
* Starts a auto changing of slides
*/
play() {
if (!this.isPlaying) {
this.isPlaying = true;
this.restartTimer();
}
}
/**
* Stops a auto changing of slides
*/
pause() {
if (!this.noPause) {
this.isPlaying = false;
this.resetTimer();
}
}
/**
* Finds and returns index of currently displayed slide
*/
getCurrentSlideIndex() {
return this._slides.findIndex(this.getActive);
}
/**
* Defines, whether the specified index is last in collection
* @param index
*/
isLast(index) {
return index + 1 >= this._slides.length;
}
/**
* Defines, whether the specified index is first in collection
* @param index
*/
isFirst(index) {
return index === 0;
}
indicatorsSlides() {
return this.slides.filter((slide, index) => !this.indicatorsByChunk || index % this.itemsPerSlide === 0);
}
selectInitialSlides() {
const startIndex = this.startFromIndex <= this._slides.length
? this.startFromIndex
: 0;
this.hideSlides();
if (this.singleSlideOffset) {
this._slidesWithIndexes = this.mapSlidesAndIndexes();
if (this._slides.length - startIndex < this.itemsPerSlide) {
const slidesToAppend = this._slidesWithIndexes.slice(0, startIndex);
this._slidesWithIndexes = [
...this._slidesWithIndexes,
...slidesToAppend
]
.slice(slidesToAppend.length)
.slice(0, this.itemsPerSlide);
}
else {
this._slidesWithIndexes = this._slidesWithIndexes.slice(startIndex, startIndex + this.itemsPerSlide);
}
this._slidesWithIndexes.forEach((slide) => slide.item.active = true);
this.makeSlidesConsistent(this._slidesWithIndexes);
}
else {
this.selectRangeByNestedIndex(startIndex);
}
this.slideRangeChange.emit(this.getVisibleIndexes());
}
/**
* Defines next slide index, depending of direction
* @param direction: Direction(UNKNOWN|PREV|NEXT)
* @param force: {boolean} if TRUE - will ignore noWrap flag, else will
* return undefined if next slide require wrapping
*/
findNextSlideIndex(direction, force) {
let nextSlideIndex = 0;
if (!force &&
(this.isLast(this.activeSlide) &&
direction !== Direction.PREV &&
this.noWrap)) {
return;
}
switch (direction) {
case Direction.NEXT:
// if this is last slide, not force, looping is disabled
// and need to going forward - select current slide, as a next
if (typeof this._currentActiveSlide === 'undefined') {
nextSlideIndex = 0;
break;
}
if (!this.isLast(this._currentActiveSlide)) {
nextSlideIndex = this._currentActiveSlide + 1;
break;
}
nextSlideIndex = !force && this.noWrap ? this._currentActiveSlide : 0;
break;
case Direction.PREV:
// if this is first slide, not force, looping is disabled
// and need to going backward - select current slide, as a next
if (typeof this._currentActiveSlide === 'undefined') {
nextSlideIndex = 0;
break;
}
if (this._currentActiveSlide > 0) {
nextSlideIndex = this._currentActiveSlide - 1;
break;
}
if (!force && this.noWrap) {
nextSlideIndex = this._currentActiveSlide;
break;
}
nextSlideIndex = this._slides.length - 1;
break;
default:
throw new Error('Unknown direction');
}
return nextSlideIndex;
}
mapSlidesAndIndexes() {
return this.slides
.slice()
.map((slide, index) => {
return {
index,
item: slide
};
});
}
selectSlideRange(index) {
if (this.isIndexInRange(index)) {
return;
}
this.hideSlides();
if (!this.singleSlideOffset) {
this.selectRangeByNestedIndex(index);
}
else {
const startIndex = this.isIndexOnTheEdges(index)
? index
: index - this.itemsPerSlide + 1;
const endIndex = this.isIndexOnTheEdges(index)
? index + this.itemsPerSlide
: index + 1;
this._slidesWithIndexes = this.mapSlidesAndIndexes().slice(startIndex, endIndex);
this.makeSlidesConsistent(this._slidesWithIndexes);
this._slidesWithIndexes.forEach((slide) => slide.item.active = true);
}
this.slideRangeChange.emit(this.getVisibleIndexes());
}
selectRangeByNestedIndex(index) {
if (!this._chunkedSlides) {
return;
}
const selectedRange = this._chunkedSlides
.map((slidesList, i) => {
return {
index: i,
list: slidesList
};
})
.find((slidesList) => {
return slidesList.list.find(slide => slide.index === index) !== undefined;
});
if (!selectedRange) {
return;
}
this._currentVisibleSlidesIndex = selectedRange.index;
this._chunkedSlides[selectedRange.index].forEach((slide) => {
slide.item.active = true;
});
}
isIndexOnTheEdges(index) {
return (index + 1 - this.itemsPerSlide <= 0 ||
index + this.itemsPerSlide <= this._slides.length);
}
isIndexInRange(index) {
if (this.singleSlideOffset && this._slidesWithIndexes) {
const visibleIndexes = this._slidesWithIndexes.map((slide) => slide.index);
return visibleIndexes.indexOf(index) >= 0;
}
return (index <= this.getLastVisibleIndex() &&
index >= this.getFirstVisibleIndex());
}
hideSlides() {
this.slides.forEach((slide) => slide.active = false);
}
isVisibleSlideListLast() {
if (!this._chunkedSlides) {
return false;
}
return this._currentVisibleSlidesIndex === this._chunkedSlides.length - 1;
}
isVisibleSlideListFirst() {
return this._currentVisibleSlidesIndex === 0;
}
moveSliderByOneItem(direction) {
let firstVisibleIndex;
let lastVisibleIndex;
let indexToHide;
let indexToShow;
if (this.noWrap) {
firstVisibleIndex = this.getFirstVisibleIndex();
lastVisibleIndex = this.getLastVisibleIndex();
indexToHide = direction === Direction.NEXT
? firstVisibleIndex
: lastVisibleIndex;
indexToShow = direction !== Direction.NEXT
? firstVisibleIndex - 1
: !this.isLast(lastVisibleIndex)
? lastVisibleIndex + 1 : 0;
const slideToHide = this._slides.get(indexToHide);
if (slideToHide) {
slideToHide.active = false;
}
const slideToShow = this._slides.get(indexToShow);
if (slideToShow) {
slideToShow.active = true;
}
const slidesToReorder = this.mapSlidesAndIndexes().filter((slide) => slide.item.active);
this.makeSlidesConsistent(slidesToReorder);
this.slideRangeChange.emit(this.getVisibleIndexes());
return;
}
if (!this._slidesWithIndexes || !this._slidesWithIndexes[0]) {
return;
}
let index;
firstVisibleIndex = this._slidesWithIndexes[0].index;
lastVisibleIndex = this._slidesWithIndexes[this._slidesWithIndexes.length - 1].index;
if (direction === Direction.NEXT) {
this._slidesWithIndexes.shift();
index = this.isLast(lastVisibleIndex)
? 0
: lastVisibleIndex + 1;
const item = this._slides.get(index);
if (item) {
this._slidesWithIndexes.push({ index, item });
}
}
else {
this._slidesWithIndexes.pop();
index = this.isFirst(firstVisibleIndex)
? this._slides.length - 1
: firstVisibleIndex - 1;
const item = this._slides.get(index);
if (item) {
this._slidesWithIndexes = [{ index, item }, ...this._slidesWithIndexes];
}
}
this.hideSlides();
this._slidesWithIndexes.forEach(slide => slide.item.active = true);
this.makeSlidesConsistent(this._slidesWithIndexes);
this.slideRangeChange.emit(this._slidesWithIndexes.map((slide) => slide.index));
}
moveMultilist(direction) {
if (this.singleSlideOffset) {
this.moveSliderByOneItem(direction);
}
else {
this.hideSlides();
if (this.noWrap) {
this._currentVisibleSlidesIndex = direction === Direction.NEXT
? this._currentVisibleSlidesIndex + 1
: this._currentVisibleSlidesIndex - 1;
}
else if (direction === Direction.NEXT) {
this._currentVisibleSlidesIndex = this.isVisibleSlideListLast()
? 0
: this._currentVisibleSlidesIndex + 1;
}
else {
if (this.isVisibleSlideListFirst()) {
this._currentVisibleSlidesIndex = this._chunkedSlides
? this._chunkedSlides.length - 1
: 0;
}
else {
this._currentVisibleSlidesIndex = this._currentVisibleSlidesIndex - 1;
}
}
if (this._chunkedSlides) {
this._chunkedSlides[this._currentVisibleSlidesIndex].forEach((slide) => slide.item.active = true);
}
this.slideRangeChange.emit(this.getVisibleIndexes());
}
}
getVisibleIndexes() {
if (!this.singleSlideOffset && this._chunkedSlides) {
return this._chunkedSlides[this._currentVisibleSlidesIndex]
.map((slide) => slide.index);
}
if (this._slidesWithIndexes) {
return this._slidesWithIndexes.map((slide) => slide.index);
}
}
/**
* Sets a slide, which specified through index, as active
* @param index
*/
_select(index) {
if (isNaN(index)) {
this.pause();
return;
}
if (!this.multilist && typeof this._currentActiveSlide !== 'undefined') {
const currentSlide = this._slides.get(this._currentActiveSlide);
if (typeof currentSlide !== 'undefined') {
currentSlide.active = false;
}
}
const nextSlide = this._slides.get(index);
if (typeof nextSlide !== 'undefined') {
this._currentActiveSlide = index;
nextSlide.active = true;
this.activeSlide = index;
this.activeSlideChange.emit(index);
}
}
/**
* Starts loop of auto changing of slides
*/
restartTimer() {
this.resetTimer();
const interval = +this.interval;
if (!isNaN(interval) && interval > 0) {
this.currentInterval = this.ngZone.runOutsideAngular(() => {
return setInterval(() => {
const nInterval = +this.interval;
this.ngZone.run(() => {
if (this.isPlaying &&
!isNaN(this.interval) &&
nInterval > 0 &&
this.slides.length) {
this.nextSlideFromInterval();
}
else {
this.pause();
}
});
}, interval);
});
}
}
get multilist() {
return this.itemsPerSlide > 1;
}
/**
* Stops loop of auto changing of slides
*/
resetTimer() {
if (this.currentInterval) {
clearInterval(this.currentInterval);
this.currentInterval = void 0;
}
}
}
CarouselComponent.decorators = [
{ type: Component, args: [{
selector: 'carousel',
template: "<div (mouseenter)=\"pause()\"\n (mouseleave)=\"onMouseLeave()\"\n (mouseup)=\"onMouseUp()\"\n (keydown)=\"keydownPress($event)\"\n (focusin)=\"pauseFocusIn()\"\n (focusout)=\"pauseFocusOut()\"\n class=\"carousel slide\" tabindex=\"0\">\n <ol class=\"carousel-indicators\" *ngIf=\"showIndicators && slides.length > 1\">\n <li *ngFor=\"let slide of indicatorsSlides(); let i = index;\"\n [class.active]=\"slide.active === true\"\n (click)=\"selectSlide(i)\">\n </li>\n </ol>\n <div class=\"carousel-inner\" [ngStyle]=\"{'display': multilist ? 'flex' : 'block'}\">\n <ng-content></ng-content>\n </div>\n <a class=\"left carousel-control carousel-control-prev\"\n [class.disabled]=\"activeSlide === 0 && noWrap\"\n (click)=\"previousSlide()\" *ngIf=\"slides.length > 1\"\n tabindex=\"0\" role=\"button\">\n <span class=\"icon-prev carousel-control-prev-icon\" aria-hidden=\"true\"></span>\n <span *ngIf=\"isBs4\" class=\"sr-only\">Previous</span>\n </a>\n <a class=\"right carousel-control carousel-control-next\"\n [class.disabled]=\"isLast(activeSlide) && noWrap\"\n (click)=\"nextSlide()\" *ngIf=\"slides.length > 1\"\n tabindex=\"0\" role=\"button\">\n <span class=\"icon-next carousel-control-next-icon\" aria-hidden=\"true\"></span>\n <span class=\"sr-only\">Next</span>\n </a>\n</div>\n"
},] }
];
CarouselComponent.ctorParameters = () => [
{ type: CarouselConfig },
{ type: NgZone }
];
CarouselComponent.propDecorators = {
noWrap: [{ type: Input }],
noPause: [{ type: Input }],
showIndicators: [{ type: Input }],
pauseOnFocus: [{ type: Input }],
indicatorsByChunk: [{ type: Input }],
itemsPerSlide: [{ type: Input }],
singleSlideOffset: [{ type: Input }],
isAnimated: [{ type: Input }],
activeSlideChange: [{ type: Output }],
slideRangeChange: [{ type: Output }],
activeSlide: [{ type: Input }],
startFromIndex: [{ type: Input }],
interval: [{ type: Input }]
};
//# sourceMappingURL=carousel.component.js.map