Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional _beforeBreakpoint

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

Type declaration

Optional _containerClasses

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

Type declaration

    • (swiper: default, classNames: string): void
    • !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

Type declaration

    • !INTERNAL: Event will be fired on free mode touch end (release) and there will no be momentum

      Parameters

      Returns void

Optional _slideClass

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

Type declaration

    • (swiper: default, slideEl: HTMLElement, classNames: string): void
    • !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

Type declaration

    • (swiper: default, slides: { classNames: string; index: number; slideEl: HTMLElement }[]): void
    • !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

Type declaration

    • !INTERNAL: Event will fired as soon as swiper instance available (before init)

      Parameters

      Returns void

activeIndexChange

activeIndexChange: (swiper: default) => void

Type declaration

    • Event will fired on active index change

      Parameters

      Returns void

afterInit

afterInit: (swiper: default) => void

Type declaration

    • Event will fired right after initialization

      Parameters

      Returns void

autoplay

autoplay: (swiper: default) => void

Type declaration

    • Event will be fired when slide changed with autoplay

      Parameters

      Returns void

autoplayStart

autoplayStart: (swiper: default) => void

Type declaration

    • Event will be fired in when autoplay started

      Parameters

      Returns void

autoplayStop

autoplayStop: (swiper: default) => void

Type declaration

    • Event will be fired when autoplay stopped

      Parameters

      Returns void

beforeDestroy

beforeDestroy: (swiper: default) => void

Type declaration

    • Event will be fired right before Swiper destroyed

      Parameters

      Returns void

beforeInit

beforeInit: (swiper: default) => void

Type declaration

    • Event will fired right before initialization

      Parameters

      Returns void

beforeLoopFix

beforeLoopFix: (swiper: default) => void

Type declaration

    • Event will be fired right before "loop fix"

      Parameters

      Returns void

beforeResize

beforeResize: (swiper: default) => void

Type declaration

    • Event will fired before resize handler

      Parameters

      Returns void

beforeSlideChangeStart

beforeSlideChangeStart: (swiper: default) => void

Type declaration

    • Event will fired before slide change transition start

      Parameters

      Returns void

beforeTransitionStart

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

Type declaration

    • (swiper: default, speed: number, internal: any): void
    • Event will fired before transition start

      Parameters

      • swiper: default
      • speed: number
      • internal: any

      Returns void

breakpoint

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

Type declaration

changeDirection

changeDirection: (swiper: default) => void

Type declaration

    • Event will fired on direction change

      Parameters

      Returns void

click

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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • Event will be fired on swiper destroy

      Parameters

      Returns void

doubleClick

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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • Event will be fired when Swiper goes from beginning or end position

      Parameters

      Returns void

hashChange

hashChange: (swiper: default) => void

Type declaration

    • Event will be fired on window hash change

      Parameters

      Returns void

hashSet

hashSet: (swiper: default) => void

Type declaration

    • Event will be fired when swiper updates the hash

      Parameters

      Returns void

imagesReady

imagesReady: (swiper: default) => void

Type declaration

    • Event will be fired right after all inner images are loaded. updateOnImagesReady should be also enabled

      Parameters

      Returns void

init

init: (swiper: default) => any

Type declaration

    • Fired right after Swiper initialization.

      Parameters

      Returns any

keyPress

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

Type declaration

    • (swiper: default, keyCode: string): void
    • Event will be fired on key press

      Parameters

      Returns void

lazyImageLoad

lazyImageLoad: (swiper: default, slideEl: HTMLElement, imageEl: HTMLElement) => void

Type declaration

    • (swiper: default, slideEl: HTMLElement, imageEl: HTMLElement): void
    • Event will be fired in the beginning of lazy loading of image

      Parameters

      • swiper: default
      • slideEl: HTMLElement
      • imageEl: HTMLElement

      Returns void

lazyImageReady

lazyImageReady: (swiper: default, slideEl: HTMLElement, imageEl: HTMLElement) => void

Type declaration

    • (swiper: default, slideEl: HTMLElement, imageEl: HTMLElement): void
    • Event will be fired when lazy loading image will be loaded

      Parameters

      • swiper: default
      • slideEl: HTMLElement
      • imageEl: HTMLElement

      Returns void

lock

lock: (swiper: default) => void

Type declaration

    • Event will be fired when swiper is locked (when watchOverflow enabled)

      Parameters

      Returns void

loopFix

loopFix: (swiper: default) => void

Type declaration

    • Event will be fired after "loop fix"

      Parameters

      Returns void

momentumBounce

momentumBounce: (swiper: default) => void

Type declaration

    • Event will be fired on momentum bounce

      Parameters

      Returns void

navigationHide

navigationHide: (swiper: default) => void

Type declaration

    • Event will be fired on navigation hide

      Parameters

      Returns void

navigationShow

navigationShow: (swiper: default) => void

Type declaration

    • Event will be fired on navigation show

      Parameters

      Returns void

observerUpdate

observerUpdate: (swiper: default) => void

Type declaration

    • Event will be fired if observer is enabled and it detects DOM mutations

      Parameters

      Returns void

orientationchange

orientationchange: (swiper: default) => void

Type declaration

    • Event will be fired on orientation change (e.g. landscape -> portrait)

      Parameters

      Returns void

paginationHide

paginationHide: (swiper: default) => void

Type declaration

    • Event will be fired on pagination hide

      Parameters

      Returns void

paginationRender

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

Type declaration

    • (swiper: default, paginationEl: HTMLElement): void
    • Event will be fired after pagination rendered

      Parameters

      • swiper: default
      • paginationEl: HTMLElement

      Returns void

paginationShow

paginationShow: (swiper: default) => void

Type declaration

    • Event will be fired on pagination show

      Parameters

      Returns void

paginationUpdate

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

Type declaration

    • (swiper: default, paginationEl: HTMLElement): void
    • Event will be fired when pagination updated

      Parameters

      • swiper: default
      • paginationEl: HTMLElement

      Returns void

progress

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

Type declaration

    • (swiper: default, progress: number): void
    • Event will be fired when Swiper progress is changed, as an arguments it receives progress that is always from 0 to 1

      Parameters

      Returns void

reachBeginning

reachBeginning: (swiper: default) => void

Type declaration

    • Event will be fired when Swiper reach its beginning (initial position)

      Parameters

      Returns void

reachEnd

reachEnd: (swiper: default) => void

Type declaration

    • Event will be fired when Swiper reach last slide

      Parameters

      Returns void

realIndexChange

realIndexChange: (swiper: default) => void

Type declaration

    • Event will fired on real index change

      Parameters

      Returns void

resize

resize: (swiper: default) => void

Type declaration

    • Event will be fired on window resize right before swiper's onresize manipulation

      Parameters

      Returns void

scroll

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

Type declaration

    • (swiper: default, event: WheelEvent): void
    • Event will be fired on mousewheel scroll

      Parameters

      • swiper: default
      • event: WheelEvent

      Returns void

scrollbarDragEnd

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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, transition: number): void
    • 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

Type declaration

    • (swiper: default, translate: number): void
    • 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

Type declaration

    • Event will be fired when currently active slide is changed

      Parameters

      Returns void

slideChangeTransitionEnd

slideChangeTransitionEnd: (swiper: default) => void

Type declaration

    • Event will be fired after animation to other slide (next or previous).

      Parameters

      Returns void

slideChangeTransitionStart

slideChangeTransitionStart: (swiper: default) => void

Type declaration

    • Event will be fired in the beginning of animation to other slide (next or previous).

      Parameters

      Returns void

slideNextTransitionEnd

slideNextTransitionEnd: (swiper: default) => void

Type declaration

    • Same as "slideChangeTransitionEnd" but for "forward" direction only

      Parameters

      Returns void

slideNextTransitionStart

slideNextTransitionStart: (swiper: default) => void

Type declaration

    • Same as "slideChangeTransitionStart" but for "forward" direction only

      Parameters

      Returns void

slidePrevTransitionEnd

slidePrevTransitionEnd: (swiper: default) => void

Type declaration

    • Same as "slideChangeTransitionEnd" but for "backward" direction only

      Parameters

      Returns void

slidePrevTransitionStart

slidePrevTransitionStart: (swiper: default) => void

Type declaration

    • Same as "slideChangeTransitionStart" but for "backward" direction only

      Parameters

      Returns void

slideResetTransitionEnd

slideResetTransitionEnd: (swiper: default) => void

Type declaration

    • Event will be fired in the end of animation of resetting slide to current one

      Parameters

      Returns void

slideResetTransitionStart

slideResetTransitionStart: (swiper: default) => void

Type declaration

    • Event will be fired in the beginning of animation of resetting slide to current one

      Parameters

      Returns void

sliderFirstMove

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

Type declaration

    • (swiper: default, event: TouchEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • Event will be fired when slides grid has changed

      Parameters

      Returns void

slidesLengthChange

slidesLengthChange: (swiper: default) => void

Type declaration

    • Event will be fired when number of slides has changed

      Parameters

      Returns void

snapGridLengthChange

snapGridLengthChange: (swiper: default) => void

Type declaration

    • Event will be fired when snap grid has changed

      Parameters

      Returns void

snapIndexChange

snapIndexChange: (swiper: default) => void

Type declaration

    • Event will fired on snap index change

      Parameters

      Returns void

tap

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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • Event will be fired when Swiper goes to beginning or end position

      Parameters

      Returns void

touchEnd

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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • (swiper: default, event: MouseEvent | TouchEvent | PointerEvent): void
    • 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

Type declaration

    • Event will be fired after transition.

      Parameters

      Returns void

transitionStart

transitionStart: (swiper: default) => void

Type declaration

    • Event will be fired in the beginning of transition.

      Parameters

      Returns void

unlock

unlock: (swiper: default) => void

Type declaration

    • Event will be fired when swiper is unlocked (when watchOverflow enabled)

      Parameters

      Returns void

update

update: (swiper: default) => void

Type declaration

    • Event will be fired after swiper.update() call

      Parameters

      Returns void

zoomChange

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

Type declaration

    • (swiper: default, scale: number, imageEl: HTMLElement, slideEl: HTMLElement): void
    • Event will be fired on zoom change

      Parameters

      • swiper: default
      • scale: number
      • imageEl: HTMLElement
      • slideEl: HTMLElement

      Returns void

Generated using TypeDoc