Skip to content

Commit

Permalink
Check for data-interval on the first slide of carousel - v4 (#31820)
Browse files Browse the repository at this point in the history
When starting a cycle for a carousel, it only checks for a default interval, and not an interval defined on the slide element via data props. This adds a check in before creating the interval to move to the next slide.

Co-authored-by: XhmikosR <xhmikosr@gmail.com>
  • Loading branch information
Mitchell Bryson and XhmikosR committed Nov 12, 2020
1 parent 9e9e1e6 commit 896e444
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .bundlewatch.config.json
Expand Up @@ -26,7 +26,7 @@
},
{
"path": "./dist/js/bootstrap.bundle.js",
"maxSize": "47.5 kB"
"maxSize": "48 kB"
},
{
"path": "./dist/js/bootstrap.bundle.min.js",
Expand Down
28 changes: 20 additions & 8 deletions js/src/carousel.js
Expand Up @@ -169,6 +169,8 @@ class Carousel {
}

if (this._config.interval && !this._isPaused) {
this._updateInterval()

this._interval = setInterval(
(document.visibilityState ? this.nextWhenVisible : this.next).bind(this),
this._config.interval
Expand Down Expand Up @@ -401,6 +403,23 @@ class Carousel {
}
}

_updateInterval() {
const element = this._activeElement || this._element.querySelector(SELECTOR_ACTIVE_ITEM)

if (!element) {
return
}

const elementInterval = parseInt(element.getAttribute('data-interval'), 10)

if (elementInterval) {
this._config.defaultInterval = this._config.defaultInterval || this._config.interval
this._config.interval = elementInterval
} else {
this._config.interval = this._config.defaultInterval || this._config.interval
}
}

_slide(direction, element) {
const activeElement = this._element.querySelector(SELECTOR_ACTIVE_ITEM)
const activeElementIndex = this._getItemIndex(activeElement)
Expand Down Expand Up @@ -445,6 +464,7 @@ class Carousel {
}

this._setActiveIndicatorElement(nextElement)
this._activeElement = nextElement

const slidEvent = $.Event(EVENT_SLID, {
relatedTarget: nextElement,
Expand All @@ -461,14 +481,6 @@ class Carousel {
$(activeElement).addClass(directionalClassName)
$(nextElement).addClass(directionalClassName)

const nextElementInterval = parseInt(nextElement.getAttribute('data-interval'), 10)
if (nextElementInterval) {
this._config.defaultInterval = this._config.defaultInterval || this._config.interval
this._config.interval = nextElementInterval
} else {
this._config.interval = this._config.defaultInterval || this._config.interval
}

const transitionDuration = Util.getTransitionDurationFromElement(activeElement)

$(activeElement)
Expand Down
15 changes: 14 additions & 1 deletion js/tests/unit/carousel.js
Expand Up @@ -480,7 +480,7 @@ $(function () {
})

QUnit.test('should set interval from data attribute on individual carousel-item', function (assert) {
assert.expect(2)
assert.expect(4)
var templateHTML = '<div id="myCarousel" class="carousel slide" data-interval="1814">' +
'<div class="carousel-inner">' +
'<div class="carousel-item active" data-interval="2814">' +
Expand Down Expand Up @@ -516,13 +516,26 @@ $(function () {
'</div>'
var $carousel = $(templateHTML)

$carousel.appendTo('body')
$carousel.bootstrapCarousel()
assert.strictEqual($carousel.data('bs.carousel')._config.interval, 1814)
$carousel.remove()

$carousel.appendTo('body')
$carousel.bootstrapCarousel(0)
$carousel.data('bs.carousel').cycle()
assert.strictEqual($carousel.data('bs.carousel')._config.interval, 2814)
$carousel.remove()

$carousel.appendTo('body')
$carousel.bootstrapCarousel(1)
$carousel.data('bs.carousel').cycle()
assert.strictEqual($carousel.data('bs.carousel')._config.interval, 3814)
$carousel.remove()

$carousel.appendTo('body')
$carousel.bootstrapCarousel(2)
$carousel.data('bs.carousel').cycle()
assert.strictEqual($carousel.data('bs.carousel')._config.interval, 1814, 'reverts to default interval if no data-interval is set')
$carousel.remove()
})
Expand Down

0 comments on commit 896e444

Please sign in to comment.