Class Carousel

Class definition

Hierarchy

BaseComponent
- Carousel

Constructors

constructor

new Carousel(element, config): Carousel
Parameters
- element: any
- config: any
Returns Carousel
Overrides BaseComponent.constructor
- Defined in src/bootstrap/js/bootstrap.esm.js:1150

Properties

_activeElement

_activeElement: any

_config

_config: any

_element

_element: any

_indicatorsElement

_indicatorsElement: any

_interval

_interval: Timeout

_isSliding

_isSliding: boolean

_swipeHelper

_swipeHelper: Swipe

touchTimeout

touchTimeout: Timeout

Accessors

`Static`DATA_KEY

get DATA_KEY(): string
Returns string
Inherited from BaseComponent.DATA_KEY
- Defined in src/bootstrap/js/bootstrap.esm.js:693

`Static`Default

get Default(): {
    interval: number;
    keyboard: boolean;
    pause: string;
    ride: boolean;
    touch: boolean;
    wrap: boolean;
}
Returns {
    interval: number;
    keyboard: boolean;
    pause: string;
    ride: boolean;
    touch: boolean;
    wrap: boolean;
}
- interval: number
- keyboard: boolean
- pause: string
- ride: boolean
- touch: boolean
- wrap: boolean
Overrides BaseComponent.Default
- Defined in src/bootstrap/js/bootstrap.esm.js:1165

`Static`DefaultType

get DefaultType(): {
    interval: string;
    keyboard: string;
    pause: string;
    ride: string;
    touch: string;
    wrap: string;
}
Returns {
    interval: string;
    keyboard: string;
    pause: string;
    ride: string;
    touch: string;
    wrap: string;
}
- interval: string
- keyboard: string
- pause: string
- ride: string
- touch: string
- wrap: string
Overrides BaseComponent.DefaultType
- Defined in src/bootstrap/js/bootstrap.esm.js:1168

`Static`EVENT_KEY

get EVENT_KEY(): string
Returns string
Inherited from BaseComponent.EVENT_KEY
- Defined in src/bootstrap/js/bootstrap.esm.js:696

`Static`NAME

get NAME(): string
Returns string
Overrides BaseComponent.NAME
- Defined in src/bootstrap/js/bootstrap.esm.js:1171

`Static`VERSION

get VERSION(): string
Returns string
Inherited from BaseComponent.VERSION
- Defined in src/bootstrap/js/bootstrap.esm.js:690

Methods

_addEventListeners

_addEventListeners(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1239

_addTouchEventListeners

_addTouchEventListeners(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1251

_clearInterval

_clearInterval(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1375

_configAfterMerge

_configAfterMerge(config): any
Parameters
- config: any
Returns any
Overrides BaseComponent._configAfterMerge
- Defined in src/bootstrap/js/bootstrap.esm.js:1235

_directionToOrder

_directionToOrder(direction): "next" | "prev"
Parameters
- direction: any
Returns "next" | "prev"
- Defined in src/bootstrap/js/bootstrap.esm.js:1381

_getActive

_getActive(): any
Returns any
- Defined in src/bootstrap/js/bootstrap.esm.js:1369

_getConfig

_getConfig(config): any
Parameters
- config: any
Returns any
Inherited from BaseComponent._getConfig
- Defined in src/bootstrap/js/bootstrap.esm.js:676

_getItemIndex

_getItemIndex(element): number
Parameters
- element: any
Returns number
- Defined in src/bootstrap/js/bootstrap.esm.js:1291

_getItems

_getItems(): any[]
Returns any[]
- Defined in src/bootstrap/js/bootstrap.esm.js:1372

_isAnimated

_isAnimated(): any
Returns any
- Defined in src/bootstrap/js/bootstrap.esm.js:1366

_keydown

_keydown(event): void
Parameters
- event: any
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1281

_maybeEnableCycle

_maybeEnableCycle(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1201

_mergeConfigObj

_mergeConfigObj(config, element): any
Parameters
- config: any
- element: any
Returns any
Inherited from BaseComponent._mergeConfigObj
- Defined in src/bootstrap/js/bootstrap.esm.js:614

_orderToDirection

_orderToDirection(order): "left" | "right"
Parameters
- order: any
Returns "left" | "right"
- Defined in src/bootstrap/js/bootstrap.esm.js:1387

_queueCallback

_queueCallback(callback, element, isAnimated?): void
Parameters
- callback: any
- element: any
- isAnimated: boolean = true
Returns void
Inherited from BaseComponent._queueCallback
- Defined in src/bootstrap/js/bootstrap.esm.js:673

_setActiveIndicatorElement

_setActiveIndicatorElement(index): void
Parameters
- index: any
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1294

_slide

_slide(order, element?): void
Parameters
- order: any
- element: any = null
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1315

_typeCheckConfig

_typeCheckConfig(config, configTypes?): void
Parameters
- config: any
- configTypes: any = ...
Returns void
Inherited from BaseComponent._typeCheckConfig
- Defined in src/bootstrap/js/bootstrap.esm.js:624

_updateInterval

_updateInterval(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1307

cycle

cycle(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1196

dispose

dispose(): void
Returns void
Overrides BaseComponent.dispose
- Defined in src/bootstrap/js/bootstrap.esm.js:1227

next

next(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1176

nextWhenVisible

nextWhenVisible(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1179

pause

pause(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1190

prev

prev(): void
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1187

to

to(index): void
Parameters
- index: any
Returns void
- Defined in src/bootstrap/js/bootstrap.esm.js:1211

`Static`eventName

eventName(name): string
Parameters
- name: any
Returns string
Inherited from BaseComponent.eventName
- Defined in src/bootstrap/js/bootstrap.esm.js:699

`Static`getInstance

getInstance(element): any
Parameters
- element: any
Returns any
Inherited from BaseComponent.getInstance
- Defined in src/bootstrap/js/bootstrap.esm.js:684

`Static`getOrCreateInstance

getOrCreateInstance(element, config?): any
Parameters
- element: any
- config: {} = {}
Returns any
Inherited from BaseComponent.getOrCreateInstance
- Defined in src/bootstrap/js/bootstrap.esm.js:687

`Static`jQueryInterface

jQueryInterface(config): any
Parameters
- config: any
Returns any
- Defined in src/bootstrap/js/bootstrap.esm.js:1395