SwiperEvents | Swiper

Index

Methods

Optional _beforeBreakpoint

_beforeBreakpoint(swiper: default, breakpointParams: SwiperOptions): void

- Defined in swiper/types/swiper-events.d.ts:214
!INTERNAL: Event will fired right before breakpoint change

Parameters
- swiper: default
- breakpointParams: SwiperOptions
Returns void

Optional _containerClasses

_containerClasses(swiper: default, classNames: string): void

- Defined in swiper/types/swiper-events.d.ts:219
!INTERNAL: Event will fired after setting CSS classes on swiper container element

Parameters
- swiper: default
- classNames: string
Returns void

Optional _freeModeNoMomentumRelease

_freeModeNoMomentumRelease(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:242
!INTERNAL: Event will be fired on free mode touch end (release) and there will no be momentum

Parameters
- swiper: default
Returns void

Optional _slideClass

_slideClass(swiper: default, slideEl: HTMLElement, classNames: string): void

- Defined in swiper/types/swiper-events.d.ts:224
!INTERNAL: Event will fired after setting CSS classes on swiper slide element

Parameters
- swiper: default
- slideEl: HTMLElement
- classNames: string
Returns void

Optional _slideClasses

_slideClasses(swiper: default, slides: { classNames: string; index: number; slideEl: HTMLElement }[]): void

- Defined in swiper/types/swiper-events.d.ts:229
!INTERNAL: Event will fired after setting CSS classes on all swiper slides

Parameters
- swiper: default
- slides: { classNames: string; index: number; slideEl: HTMLElement }[]
Returns void

Optional _swiper

_swiper(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:237
!INTERNAL: Event will fired as soon as swiper instance available (before init)

Parameters
- swiper: default
Returns void

activeIndexChange

activeIndexChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:247
Event will fired on active index change

Parameters
- swiper: default
Returns void

afterInit

afterInit(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:259
Event will fired right after initialization

Parameters
- swiper: default
Returns void

autoplay

autoplay(swiper: default): void

Inherited from AutoplayEvents.autoplay
- Defined in swiper/types/modules/autoplay.d.ts:64
Event will be fired when slide changed with autoplay

Parameters
- swiper: default
Returns void

autoplayPause

autoplayPause(swiper: default): void

Inherited from AutoplayEvents.autoplayPause
- Defined in swiper/types/modules/autoplay.d.ts:52
Event will be fired on autoplay pause

Parameters
- swiper: default
Returns void

autoplayResume

autoplayResume(swiper: default): void

Inherited from AutoplayEvents.autoplayResume
- Defined in swiper/types/modules/autoplay.d.ts:56
Event will be fired on autoplay resume

Parameters
- swiper: default
Returns void

autoplayStart

autoplayStart(swiper: default): void

Inherited from AutoplayEvents.autoplayStart
- Defined in swiper/types/modules/autoplay.d.ts:44
Event will be fired in when autoplay started

Parameters
- swiper: default
Returns void

autoplayStop

autoplayStop(swiper: default): void

Inherited from AutoplayEvents.autoplayStop
- Defined in swiper/types/modules/autoplay.d.ts:48
Event will be fired when autoplay stopped

Parameters
- swiper: default
Returns void

autoplayTimeLeft

autoplayTimeLeft(swiper: default, timeLeft: number, percentage: number): void

Inherited from AutoplayEvents.autoplayTimeLeft
- Defined in swiper/types/modules/autoplay.d.ts:60
Event triggers continuously while autoplay is enabled. It contains time left (in ms) before transition to next slide and percentage of that time related to autoplay delay

Parameters
- swiper: default
- timeLeft: number
- percentage: number
Returns void

beforeDestroy

beforeDestroy(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:64
Event will be fired right before Swiper destroyed

Parameters
- swiper: default
Returns void

beforeInit

beforeInit(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:263
Event will fired right before initialization

Parameters
- swiper: default
Returns void

beforeLoopFix

beforeLoopFix(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:199
Event will be fired right before "loop fix"

Parameters
- swiper: default
Returns void

beforeResize

beforeResize(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:267
Event will fired before resize handler

Parameters
- swiper: default
Returns void

beforeSlideChangeStart

beforeSlideChangeStart(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:271
Event will fired before slide change transition start

Parameters
- swiper: default
Returns void

beforeTransitionStart

beforeTransitionStart(swiper: default, speed: number, internal: any): void

- Defined in swiper/types/swiper-events.d.ts:275
Event will fired before transition start

Parameters
- swiper: default
- speed: number
- internal: any
Returns void

breakpoint

breakpoint(swiper: default, breakpointParams: SwiperOptions): void

- Defined in swiper/types/swiper-events.d.ts:209
Event will be fired on breakpoint change

Parameters
- swiper: default
- breakpointParams: SwiperOptions
Returns void

changeDirection

changeDirection(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:279
Event will fired on direction change

Parameters
- swiper: default
Returns void

click

click(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:139
Event will be fired when user click/tap on Swiper. Receives touchend event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

destroy

destroy(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:287
Event will be fired on swiper destroy

Parameters
- swiper: default
Returns void

doubleClick

doubleClick(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:283
Event will be fired when user double click/tap on Swiper

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

doubleTap

doubleTap(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:149
Event will be fired when user double tap on Swiper's container. Receives touchend event as an arguments

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

fromEdge

fromEdge(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:174
Event will be fired when Swiper goes from beginning or end position

Parameters
- swiper: default
Returns void

hashChange

hashChange(swiper: default): void

Inherited from HashNavigationEvents.hashChange
- Defined in swiper/types/modules/hash-navigation.d.ts:9
Event will be fired on window hash change

Parameters
- swiper: default
Returns void

hashSet

hashSet(swiper: default): void

Inherited from HashNavigationEvents.hashSet
- Defined in swiper/types/modules/hash-navigation.d.ts:13
Event will be fired when swiper updates the hash

Parameters
- swiper: default
Returns void

init

init(swiper: default): any

Fired right after Swiper initialization.

note

Note that with swiper.on('init') syntax it will work only in case you set init: false parameter.

example

const swiper = new Swiper('.swiper', {
  init: false,
  // other parameters
});
swiper.on('init', function() {
 // do something
});
// init Swiper
swiper.init();

example

// Otherwise use it as the parameter:
const swiper = new Swiper('.swiper', {
  // other parameters
  on: {
    init: function () {
      // do something
    },
  }
});

Parameters

swiper: default

Returns any

keyPress

keyPress(swiper: default, keyCode: string): void

Inherited from KeyboardEvents.keyPress
- Defined in swiper/types/modules/keyboard.d.ts:24
Event will be fired on key press

Parameters
- swiper: default
- keyCode: string
Returns void

lock

lock(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:327
Event will be fired when swiper is locked (when watchOverflow enabled)

Parameters
- swiper: default
Returns void

loopFix

loopFix(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:204
Event will be fired after "loop fix"

Parameters
- swiper: default
Returns void

momentumBounce

momentumBounce(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:291
Event will be fired on momentum bounce

Parameters
- swiper: default
Returns void

navigationHide

navigationHide(swiper: default): void

Inherited from NavigationEvents.navigationHide
- Defined in swiper/types/modules/navigation.d.ts:35
Event will be fired on navigation hide

Parameters
- swiper: default
Returns void

navigationNext

navigationNext(swiper: default): void

Inherited from NavigationEvents.navigationNext
- Defined in swiper/types/modules/navigation.d.ts:47
Event will be fired on navigation next button click

Parameters
- swiper: default
Returns void

navigationPrev

navigationPrev(swiper: default): void

Inherited from NavigationEvents.navigationPrev
- Defined in swiper/types/modules/navigation.d.ts:43
Event will be fired on navigation prev button click

Parameters
- swiper: default
Returns void

navigationShow

navigationShow(swiper: default): void

Inherited from NavigationEvents.navigationShow
- Defined in swiper/types/modules/navigation.d.ts:39
Event will be fired on navigation show

Parameters
- swiper: default
Returns void

observerUpdate

observerUpdate(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:194
Event will be fired if observer is enabled and it detects DOM mutations

Parameters
- swiper: default
Returns void

orientationchange

orientationchange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:295
Event will be fired on orientation change (e.g. landscape -> portrait)

Parameters
- swiper: default
Returns void

paginationHide

paginationHide(swiper: default): void

Inherited from PaginationEvents.paginationHide
- Defined in swiper/types/modules/pagination.d.ts:52
Event will be fired on pagination hide

Parameters
- swiper: default
Returns void

paginationRender

paginationRender(swiper: default, paginationEl: HTMLElement): void

Inherited from PaginationEvents.paginationRender
- Defined in swiper/types/modules/pagination.d.ts:42
Event will be fired after pagination rendered

Parameters
- swiper: default
- paginationEl: HTMLElement
Returns void

paginationShow

paginationShow(swiper: default): void

Inherited from PaginationEvents.paginationShow
- Defined in swiper/types/modules/pagination.d.ts:57
Event will be fired on pagination show

Parameters
- swiper: default
Returns void

paginationUpdate

paginationUpdate(swiper: default, paginationEl: HTMLElement): void

Inherited from PaginationEvents.paginationUpdate
- Defined in swiper/types/modules/pagination.d.ts:47
Event will be fired when pagination updated

Parameters
- swiper: default
- paginationEl: HTMLElement
Returns void

progress

progress(swiper: default, progress: number): void

- Defined in swiper/types/swiper-events.d.ts:154
Event will be fired when Swiper progress is changed, as an arguments it receives progress that is always from 0 to 1

Parameters
- swiper: default
- progress: number
Returns void

reachBeginning

reachBeginning(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:159
Event will be fired when Swiper reach its beginning (initial position)

Parameters
- swiper: default
Returns void

reachEnd

reachEnd(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:164
Event will be fired when Swiper reach last slide

Parameters
- swiper: default
Returns void

realIndexChange

realIndexChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:255
Event will fired on real index change

Parameters
- swiper: default
Returns void

resize

resize(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:189
Event will be fired on window resize right before swiper's onresize manipulation

Parameters
- swiper: default
Returns void

scroll

scroll(swiper: default, event: WheelEvent): void

Inherited from MousewheelEvents.scroll
- Defined in swiper/types/modules/mousewheel.d.ts:25
Event will be fired on mousewheel scroll

Parameters
- swiper: default
- event: WheelEvent
Returns void

scrollbarDragEnd

scrollbarDragEnd(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

Inherited from ScrollbarEvents.scrollbarDragEnd
- Defined in swiper/types/modules/scrollbar.d.ts:50
Event will be fired on draggable scrollbar drag end

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

scrollbarDragMove

scrollbarDragMove(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

Inherited from ScrollbarEvents.scrollbarDragMove
- Defined in swiper/types/modules/scrollbar.d.ts:45
Event will be fired on draggable scrollbar drag move

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

scrollbarDragStart

scrollbarDragStart(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

Inherited from ScrollbarEvents.scrollbarDragStart
- Defined in swiper/types/modules/scrollbar.d.ts:40
Event will be fired on draggable scrollbar drag start

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

setTransition

setTransition(swiper: default, transition: number): void

- Defined in swiper/types/swiper-events.d.ts:184
Event will be fired everytime when swiper starts animation. Receives current transition duration (in ms) as an arguments

Parameters
- swiper: default
- transition: number
Returns void

setTranslate

setTranslate(swiper: default, translate: number): void

- Defined in swiper/types/swiper-events.d.ts:179
Event will be fired when swiper's wrapper change its position. Receives current translate value as an arguments

Parameters
- swiper: default
- translate: number
Returns void

slideChange

slideChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:69
Event will be fired when currently active slide is changed

Parameters
- swiper: default
Returns void

slideChangeTransitionEnd

slideChangeTransitionEnd(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:79
Event will be fired after animation to other slide (next or previous).

Parameters
- swiper: default
Returns void

slideChangeTransitionStart

slideChangeTransitionStart(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:74
Event will be fired in the beginning of animation to other slide (next or previous).

Parameters
- swiper: default
Returns void

slideNextTransitionEnd

slideNextTransitionEnd(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:89
Same as "slideChangeTransitionEnd" but for "forward" direction only

Parameters
- swiper: default
Returns void

slideNextTransitionStart

slideNextTransitionStart(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:84
Same as "slideChangeTransitionStart" but for "forward" direction only

Parameters
- swiper: default
Returns void

slidePrevTransitionEnd

slidePrevTransitionEnd(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:99
Same as "slideChangeTransitionEnd" but for "backward" direction only

Parameters
- swiper: default
Returns void

slidePrevTransitionStart

slidePrevTransitionStart(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:94
Same as "slideChangeTransitionStart" but for "backward" direction only

Parameters
- swiper: default
Returns void

slideResetTransitionEnd

slideResetTransitionEnd(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:303
Event will be fired in the end of animation of resetting slide to current one

Parameters
- swiper: default
Returns void

slideResetTransitionStart

slideResetTransitionStart(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:299
Event will be fired in the beginning of animation of resetting slide to current one

Parameters
- swiper: default
Returns void

sliderFirstMove

sliderFirstMove(swiper: default, event: TouchEvent): void

- Defined in swiper/types/swiper-events.d.ts:307
Event will be fired with first touch/drag move

Parameters
- swiper: default
- event: TouchEvent
Returns void

sliderMove

sliderMove(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:129
Event will be fired when user touch and move finger over Swiper and move it. Receives touchmove event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

slidesGridLengthChange

slidesGridLengthChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:315
Event will be fired when slides grid has changed

Parameters
- swiper: default
Returns void

slidesLengthChange

slidesLengthChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:311
Event will be fired when number of slides has changed

Parameters
- swiper: default
Returns void

snapGridLengthChange

snapGridLengthChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:319
Event will be fired when snap grid has changed

Parameters
- swiper: default
Returns void

snapIndexChange

snapIndexChange(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:251
Event will fired on snap index change

Parameters
- swiper: default
Returns void

tap

tap(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:144
Event will be fired when user click/tap on Swiper. Receives touchend event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

toEdge

toEdge(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:169
Event will be fired when Swiper goes to beginning or end position

Parameters
- swiper: default
Returns void

touchEnd

touchEnd(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:134
Event will be fired when user release Swiper. Receives touchend event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

touchMove

touchMove(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:119
Event will be fired when user touch and move finger over Swiper. Receives touchmove event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

touchMoveOpposite

touchMoveOpposite(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:124
Event will be fired when user touch and move finger over Swiper in direction opposite to direction parameter. Receives touchmove event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

touchStart

touchStart(swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void

- Defined in swiper/types/swiper-events.d.ts:114
Event will be fired when user touch Swiper. Receives touchstart event as an arguments.

Parameters
- swiper: default
- event: MouseEvent | TouchEvent | PointerEvent
Returns void

transitionEnd

transitionEnd(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:109
Event will be fired after transition.

Parameters
- swiper: default
Returns void

transitionStart

transitionStart(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:104
Event will be fired in the beginning of transition.

Parameters
- swiper: default
Returns void

unlock

unlock(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:331
Event will be fired when swiper is unlocked (when watchOverflow enabled)

Parameters
- swiper: default
Returns void

update

update(swiper: default): void

- Defined in swiper/types/swiper-events.d.ts:323
Event will be fired after swiper.update() call

Parameters
- swiper: default
Returns void

zoomChange

zoomChange(swiper: default, scale: number, imageEl: HTMLElement, slideEl: HTMLElement): void

Inherited from ZoomEvents.zoomChange
- Defined in swiper/types/modules/zoom.d.ts:44
Event will be fired on zoom change

Parameters
- swiper: default
- scale: number
- imageEl: HTMLElement
- slideEl: HTMLElement
Returns void

Hierarchy

Index

Methods

Methods

Optional _beforeBreakpoint

Parameters

swiper: default

breakpointParams: SwiperOptions

Returns void

Optional _containerClasses

Parameters

swiper: default

classNames: string

Returns void

Optional _freeModeNoMomentumRelease

Parameters

swiper: default

Returns void

Optional _slideClass

Parameters

swiper: default

slideEl: HTMLElement

classNames: string

Returns void

Optional _slideClasses

Parameters

swiper: default

slides: { classNames: string; index: number; slideEl: HTMLElement }[]

Returns void

Optional _swiper

Parameters

swiper: default

Returns void

activeIndexChange

Parameters

swiper: default

Returns void

afterInit

Parameters

swiper: default

Returns void

autoplay

Parameters

swiper: default

Returns void

autoplayPause

Parameters

swiper: default

Returns void

autoplayResume

Parameters

swiper: default

Returns void

autoplayStart

Parameters

swiper: default

Returns void

autoplayStop

Parameters

swiper: default

Returns void

autoplayTimeLeft

Parameters

swiper: default

timeLeft: number

percentage: number

Returns void

beforeDestroy

Parameters

swiper: default

Returns void

beforeInit

Parameters

swiper: default

Returns void

beforeLoopFix

Parameters

swiper: default

Returns void

beforeResize