0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-04 16:24:22 +01:00
Bootstrap/js/src/carousel.js

523 lines
13 KiB
JavaScript
Raw Normal View History

2015-05-08 07:26:40 +02:00
/**
* --------------------------------------------------------------------------
2021-10-09 08:33:12 +02:00
* Bootstrap (v5.1.3): carousel.js
2020-06-16 20:41:47 +02:00
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
2015-05-08 07:26:40 +02:00
* --------------------------------------------------------------------------
*/
import {
defineJQueryPlugin,
getElementFromSelector,
getNextActiveElement,
isRTL,
isVisible,
reflow,
triggerTransitionEnd
} from './util/index'
import EventHandler from './dom/event-handler'
import Manipulator from './dom/manipulator'
import SelectorEngine from './dom/selector-engine'
import Swipe from './util/swipe'
2019-09-04 16:58:29 +02:00
import BaseComponent from './base-component'
2018-10-14 13:59:51 +02:00
2018-09-26 10:39:01 +02:00
/**
* Constants
*/
2015-05-13 23:46:50 +02:00
2019-02-26 12:20:34 +01:00
const NAME = 'carousel'
const DATA_KEY = 'bs.carousel'
const EVENT_KEY = `.${DATA_KEY}`
const DATA_API_KEY = '.data-api'
const ARROW_LEFT_KEY = 'ArrowLeft'
const ARROW_RIGHT_KEY = 'ArrowRight'
2018-09-26 10:39:01 +02:00
const TOUCHEVENT_COMPAT_WAIT = 500 // Time for mouse compat events to fire after touch
const ORDER_NEXT = 'next'
const ORDER_PREV = 'prev'
const DIRECTION_LEFT = 'left'
const DIRECTION_RIGHT = 'right'
const EVENT_SLIDE = `slide${EVENT_KEY}`
const EVENT_SLID = `slid${EVENT_KEY}`
const EVENT_KEYDOWN = `keydown${EVENT_KEY}`
const EVENT_MOUSEENTER = `mouseenter${EVENT_KEY}`
const EVENT_MOUSELEAVE = `mouseleave${EVENT_KEY}`
const EVENT_DRAG_START = `dragstart${EVENT_KEY}`
const EVENT_LOAD_DATA_API = `load${EVENT_KEY}${DATA_API_KEY}`
const EVENT_CLICK_DATA_API = `click${EVENT_KEY}${DATA_API_KEY}`
const CLASS_NAME_CAROUSEL = 'carousel'
const CLASS_NAME_ACTIVE = 'active'
const CLASS_NAME_SLIDE = 'slide'
const CLASS_NAME_END = 'carousel-item-end'
const CLASS_NAME_START = 'carousel-item-start'
const CLASS_NAME_NEXT = 'carousel-item-next'
const CLASS_NAME_PREV = 'carousel-item-prev'
const SELECTOR_ACTIVE = '.active'
const SELECTOR_ACTIVE_ITEM = '.active.carousel-item'
const SELECTOR_ITEM = '.carousel-item'
const SELECTOR_ITEM_IMG = '.carousel-item img'
const SELECTOR_NEXT_PREV = '.carousel-item-next, .carousel-item-prev'
const SELECTOR_INDICATORS = '.carousel-indicators'
const SELECTOR_DATA_SLIDE = '[data-bs-slide], [data-bs-slide-to]'
const SELECTOR_DATA_RIDE = '[data-bs-ride="carousel"]'
2015-05-08 07:26:40 +02:00
const KEY_TO_DIRECTION = {
[ARROW_LEFT_KEY]: DIRECTION_RIGHT,
[ARROW_RIGHT_KEY]: DIRECTION_LEFT
}
const Default = {
interval: 5000,
keyboard: true,
slide: false,
pause: 'hover',
wrap: true,
touch: true
}
const DefaultType = {
interval: '(number|boolean)',
keyboard: 'boolean',
slide: '(boolean|string)',
pause: '(string|boolean)',
wrap: 'boolean',
touch: 'boolean'
}
2018-09-26 10:39:01 +02:00
/**
* Class definition
2018-09-26 10:39:01 +02:00
*/
2019-09-04 16:58:29 +02:00
class Carousel extends BaseComponent {
2018-09-26 10:39:01 +02:00
constructor(element, config) {
super(element, config)
2019-09-04 16:58:29 +02:00
2019-02-26 12:20:34 +01:00
this._items = null
this._interval = null
this._activeElement = null
2019-02-26 12:20:34 +01:00
this._isPaused = false
this._isSliding = false
this.touchTimeout = null
this._swipeHelper = null
2019-02-26 12:20:34 +01:00
this._indicatorsElement = SelectorEngine.findOne(SELECTOR_INDICATORS, this._element)
2018-09-26 10:39:01 +02:00
this._addEventListeners()
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
// Getters
static get Default() {
return Default
}
static get DefaultType() {
return DefaultType
}
static get NAME() {
return NAME
2019-09-04 16:58:29 +02:00
}
2018-09-26 10:39:01 +02:00
// Public
next() {
this._slide(ORDER_NEXT)
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
nextWhenVisible() {
// FIXME TODO use `document.visibilityState`
2018-09-26 10:39:01 +02:00
// Don't call next when the page isn't visible
// or the carousel or its parent isn't visible
if (!document.hidden && isVisible(this._element)) {
2018-09-26 10:39:01 +02:00
this.next()
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
prev() {
this._slide(ORDER_PREV)
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
pause(event) {
if (!event) {
this._isPaused = true
}
if (SelectorEngine.findOne(SELECTOR_NEXT_PREV, this._element)) {
triggerTransitionEnd(this._element)
2018-09-26 10:39:01 +02:00
this.cycle(true)
2015-05-08 07:26:40 +02:00
}
this._clearInterval()
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
cycle(event) {
if (!event) {
this._isPaused = false
}
2015-05-08 07:26:40 +02:00
this._clearInterval()
if (this._config.interval && !this._isPaused) {
this._updateInterval()
this._interval = setInterval(() => this.nextWhenVisible(), this._config.interval)
2018-09-26 10:39:01 +02:00
}
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
to(index) {
this._activeElement = this._getActive()
2018-09-26 10:39:01 +02:00
const activeIndex = this._getItemIndex(this._activeElement)
if (index > this._items.length - 1 || index < 0) {
return
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
if (this._isSliding) {
EventHandler.one(this._element, EVENT_SLID, () => this.to(index))
2018-09-26 10:39:01 +02:00
return
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
if (activeIndex === index) {
this.pause()
this.cycle()
return
}
2015-05-08 07:26:40 +02:00
const order = index > activeIndex ?
ORDER_NEXT :
ORDER_PREV
2015-05-08 07:26:40 +02:00
this._slide(order, this._items[index])
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
dispose() {
if (this._swipeHelper) {
this._swipeHelper.dispose()
}
super.dispose()
}
2018-09-26 10:39:01 +02:00
// Private
_configAfterMerge(config) {
config.defaultInterval = config.interval
return config
}
2018-09-26 10:39:01 +02:00
_addEventListeners() {
if (this._config.keyboard) {
2020-06-20 18:00:53 +02:00
EventHandler.on(this._element, EVENT_KEYDOWN, event => this._keydown(event))
2015-05-13 21:48:34 +02:00
}
2018-09-26 10:39:01 +02:00
if (this._config.pause === 'hover') {
2020-06-20 18:00:53 +02:00
EventHandler.on(this._element, EVENT_MOUSEENTER, event => this.pause(event))
EventHandler.on(this._element, EVENT_MOUSELEAVE, event => this.cycle(event))
2018-10-14 13:59:51 +02:00
}
if (this._config.touch && Swipe.isSupported()) {
this._addTouchEventListeners()
}
2018-10-14 13:59:51 +02:00
}
_addTouchEventListeners() {
2021-10-29 09:38:35 +02:00
for (const img of SelectorEngine.find(SELECTOR_ITEM_IMG, this._element)) {
EventHandler.on(img, EVENT_DRAG_START, event => event.preventDefault())
2018-10-14 23:10:13 +02:00
}
const endCallBack = () => {
2018-10-14 13:59:51 +02:00
if (this._config.pause === 'hover') {
2018-09-26 10:39:01 +02:00
// If it's a touch-enabled device, mouseenter/leave are fired as
// part of the mouse compatibility events on first tap - the carousel
// would stop cycling until user tapped out of it;
// here, we listen for touchend, explicitly pause the carousel
// (as if it's the second time we tap on it, mouseenter compat event
// is NOT fired) and after a timeout (to allow for mouse compatibility
// events to fire) we explicitly restart cycling
2018-10-14 13:59:51 +02:00
this.pause()
if (this.touchTimeout) {
clearTimeout(this.touchTimeout)
}
2019-02-26 12:20:34 +01:00
this.touchTimeout = setTimeout(event => this.cycle(event), TOUCHEVENT_COMPAT_WAIT + this._config.interval)
}
2018-10-14 23:10:13 +02:00
}
const swipeConfig = {
leftCallback: () => this._slide(DIRECTION_LEFT),
rightCallback: () => this._slide(DIRECTION_RIGHT),
endCallback: endCallBack
}
this._swipeHelper = new Swipe(this._element, swipeConfig)
2018-09-26 10:39:01 +02:00
}
2015-05-13 23:46:50 +02:00
2018-09-26 10:39:01 +02:00
_keydown(event) {
if (/input|textarea/i.test(event.target.tagName)) {
return
2015-05-08 07:26:40 +02:00
}
const direction = KEY_TO_DIRECTION[event.key]
if (direction) {
event.preventDefault()
this._slide(direction)
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
_getItemIndex(element) {
2019-02-26 12:20:34 +01:00
this._items = element && element.parentNode ?
SelectorEngine.find(SELECTOR_ITEM, element.parentNode) :
2019-02-26 12:20:34 +01:00
[]
2017-08-24 22:22:02 +02:00
2018-09-26 10:39:01 +02:00
return this._items.indexOf(element)
}
2015-05-08 07:26:40 +02:00
_getItemByOrder(order, activeElement) {
const isNext = order === ORDER_NEXT
return getNextActiveElement(this._items, activeElement, isNext, this._config.wrap)
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
_triggerSlideEvent(relatedTarget, eventDirectionName) {
const targetIndex = this._getItemIndex(relatedTarget)
const fromIndex = this._getItemIndex(this._getActive())
2017-08-24 22:22:02 +02:00
return EventHandler.trigger(this._element, EVENT_SLIDE, {
2018-09-26 10:39:01 +02:00
relatedTarget,
direction: eventDirectionName,
from: fromIndex,
to: targetIndex
})
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
_setActiveIndicatorElement(element) {
if (!this._indicatorsElement) {
return
}
2020-12-02 05:45:15 +01:00
const activeIndicator = SelectorEngine.findOne(SELECTOR_ACTIVE, this._indicatorsElement)
2015-05-08 07:26:40 +02:00
activeIndicator.classList.remove(CLASS_NAME_ACTIVE)
activeIndicator.removeAttribute('aria-current')
2015-05-08 07:26:40 +02:00
const newActiveIndicator = SelectorEngine.findOne(`[data-bs-slide-to="${this._getItemIndex(element)}"]`, this._indicatorsElement)
if (newActiveIndicator) {
newActiveIndicator.classList.add(CLASS_NAME_ACTIVE)
newActiveIndicator.setAttribute('aria-current', 'true')
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
_updateInterval() {
const element = this._activeElement || this._getActive()
if (!element) {
return
}
2020-05-02 15:49:33 +02:00
const elementInterval = Number.parseInt(element.getAttribute('data-bs-interval'), 10)
this._config.interval = elementInterval || this._config.defaultInterval
}
_slide(directionOrOrder, element) {
const order = this._directionToOrder(directionOrOrder)
const activeElement = this._getActive()
2018-09-26 10:39:01 +02:00
const activeElementIndex = this._getItemIndex(activeElement)
const nextElement = element || this._getItemByOrder(order, activeElement)
2017-08-24 22:22:02 +02:00
2018-09-26 10:39:01 +02:00
const nextElementIndex = this._getItemIndex(nextElement)
const isCycling = Boolean(this._interval)
const isNext = order === ORDER_NEXT
const directionalClassName = isNext ? CLASS_NAME_START : CLASS_NAME_END
const orderClassName = isNext ? CLASS_NAME_NEXT : CLASS_NAME_PREV
const eventDirectionName = this._orderToDirection(order)
2016-12-05 04:53:16 +01:00
if (nextElement && nextElement.classList.contains(CLASS_NAME_ACTIVE)) {
2018-09-26 10:39:01 +02:00
this._isSliding = false
return
}
2015-05-08 07:26:40 +02:00
if (this._isSliding) {
return
}
2018-09-26 10:39:01 +02:00
const slideEvent = this._triggerSlideEvent(nextElement, eventDirectionName)
2017-08-24 22:22:02 +02:00
if (slideEvent.defaultPrevented) {
2018-09-26 10:39:01 +02:00
return
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
if (!activeElement || !nextElement) {
// Some weirdness is happening, so we bail
return
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
this._isSliding = true
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
if (isCycling) {
this.pause()
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
this._setActiveIndicatorElement(nextElement)
this._activeElement = nextElement
2015-05-08 07:26:40 +02:00
const triggerSlidEvent = () => {
EventHandler.trigger(this._element, EVENT_SLID, {
relatedTarget: nextElement,
direction: eventDirectionName,
from: activeElementIndex,
to: nextElementIndex
})
}
if (this._element.classList.contains(CLASS_NAME_SLIDE)) {
2017-08-24 22:22:02 +02:00
nextElement.classList.add(orderClassName)
2015-05-08 07:26:40 +02:00
reflow(nextElement)
2015-05-08 07:26:40 +02:00
2017-08-24 22:22:02 +02:00
activeElement.classList.add(directionalClassName)
nextElement.classList.add(directionalClassName)
const completeCallBack = () => {
2020-06-20 18:00:53 +02:00
nextElement.classList.remove(directionalClassName, orderClassName)
nextElement.classList.add(CLASS_NAME_ACTIVE)
2015-05-08 07:26:40 +02:00
2020-06-20 18:00:53 +02:00
activeElement.classList.remove(CLASS_NAME_ACTIVE, orderClassName, directionalClassName)
2015-05-08 07:26:40 +02:00
2020-06-20 18:00:53 +02:00
this._isSliding = false
2015-05-08 07:26:40 +02:00
setTimeout(triggerSlidEvent, 0)
}
2017-08-19 17:24:45 +02:00
this._queueCallback(completeCallBack, activeElement, true)
2018-09-26 10:39:01 +02:00
} else {
activeElement.classList.remove(CLASS_NAME_ACTIVE)
nextElement.classList.add(CLASS_NAME_ACTIVE)
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
this._isSliding = false
triggerSlidEvent()
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
if (isCycling) {
this.cycle()
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
_getActive() {
return SelectorEngine.findOne(SELECTOR_ACTIVE_ITEM, this._element)
}
_clearInterval() {
if (this._interval) {
clearInterval(this._interval)
this._interval = null
}
}
_directionToOrder(direction) {
if (![DIRECTION_RIGHT, DIRECTION_LEFT].includes(direction)) {
return direction
}
if (isRTL()) {
return direction === DIRECTION_LEFT ? ORDER_PREV : ORDER_NEXT
}
return direction === DIRECTION_LEFT ? ORDER_NEXT : ORDER_PREV
}
_orderToDirection(order) {
if (![ORDER_NEXT, ORDER_PREV].includes(order)) {
return order
}
if (isRTL()) {
return order === ORDER_PREV ? DIRECTION_LEFT : DIRECTION_RIGHT
}
return order === ORDER_PREV ? DIRECTION_RIGHT : DIRECTION_LEFT
}
2018-09-26 10:39:01 +02:00
// Static
2019-07-28 15:24:46 +02:00
static carouselInterface(element, config) {
const data = Carousel.getOrCreateInstance(element, config)
2015-05-08 07:26:40 +02:00
let { _config } = data
if (typeof config === 'object') {
_config = {
..._config,
...config
}
}
const action = typeof config === 'string' ? config : _config.slide
2015-05-08 07:26:40 +02:00
if (typeof config === 'number') {
data.to(config)
} else if (typeof action === 'string') {
if (typeof data[action] === 'undefined') {
2019-02-26 12:20:34 +01:00
throw new TypeError(`No method named "${action}"`)
2015-05-08 07:26:40 +02:00
}
2019-02-26 12:20:34 +01:00
data[action]()
} else if (_config.interval && _config.ride) {
data.pause()
data.cycle()
}
}
2019-07-28 15:24:46 +02:00
static jQueryInterface(config) {
return this.each(function () {
2019-07-28 15:24:46 +02:00
Carousel.carouselInterface(this, config)
2018-09-26 10:39:01 +02:00
})
}
2015-05-08 07:26:40 +02:00
2019-07-28 15:24:46 +02:00
static dataApiClickHandler(event) {
const target = getElementFromSelector(this)
2015-08-19 04:22:46 +02:00
if (!target || !target.classList.contains(CLASS_NAME_CAROUSEL)) {
2018-09-26 10:39:01 +02:00
return
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
const config = {
...Manipulator.getDataAttributes(target),
...Manipulator.getDataAttributes(this)
2018-09-26 10:39:01 +02:00
}
const slideIndex = this.getAttribute('data-bs-slide-to')
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
if (slideIndex) {
config.interval = false
}
2019-07-28 15:24:46 +02:00
Carousel.carouselInterface(target, config)
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
if (slideIndex) {
Carousel.getInstance(target).to(slideIndex)
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
event.preventDefault()
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
}
2015-05-08 07:26:40 +02:00
2018-09-26 10:39:01 +02:00
/**
* Data API implementation
2018-09-26 10:39:01 +02:00
*/
2015-05-08 07:26:40 +02:00
2020-06-20 18:00:53 +02:00
EventHandler.on(document, EVENT_CLICK_DATA_API, SELECTOR_DATA_SLIDE, Carousel.dataApiClickHandler)
2015-05-08 07:26:40 +02:00
EventHandler.on(window, EVENT_LOAD_DATA_API, () => {
const carousels = SelectorEngine.find(SELECTOR_DATA_RIDE)
2021-08-10 17:07:39 +02:00
for (const carousel of carousels) {
Carousel.carouselInterface(carousel, Carousel.getInstance(carousel))
2015-05-08 07:26:40 +02:00
}
2018-09-26 10:39:01 +02:00
})
/**
* jQuery
*/
defineJQueryPlugin(Carousel)
2015-05-08 07:26:40 +02:00
export default Carousel