new Carousel(element, options)
- Source:
Parameters:
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
element | HTMLElement | DOM element for component instantiation and scope | |||||||||||||||||||||
options | Object | Properties
|
Classes
Methods
checkBannerHeights()
- Description:
Set the banners height above the xl breakpoint
- Source:
checkIndex(e)
- Description:
Action to update slides index and position.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
e | Event |
destroy()
- Description:
Destroy component.
- Source:
dragAction(e)
- Description:
TouchMove handler.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
e | Event |
dragEnd()
- Description:
TouchEnd handler.
- Source:
dragStart(e)
- Description:
TouchStart handler.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
e | Event |
handleAutoPlay()
- Description:
Toggles play/pause slides.
- Source:
handleFocus(e)
- Description:
Trigger events on focus.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
e | Event |
handleKeyboardOnBullets(e)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
e | Event |
handleKeyboardOnPlay(e)
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
e | Event |
handleMouseOut()
- Description:
Trigger events on mouseout.
- Source:
handleMouseOver()
- Description:
Trigger events on mouseover.
- Source:
handleResize()
- Description:
Trigger events on resize.
- Source:
init()
- Description:
Initialise component.
- Source:
moveSlides(transition)
- Description:
Transition for the slides.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
transition | Boolean |
resetBannerHeights()
- Description:
Set the banners height below the xl breakpoint
- Source:
shiftSlide(dir, stopAutoPlay)
- Description:
Action to shift next or previous slide.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
dir | int | string | |
stopAutoPlay | Boolean |
(static) autoInit(root) → {Carousel}
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
root | HTMLElement | DOM element for component instantiation and scope |
Returns:
An instance of Carousel.
- Type
- Carousel