Swiper - v14.0.1
    Preparing search index...

    Interface SwiperEvents

    interface SwiperEvents {
        _beforeBreakpoint?: (
            swiper: Swiper,
            breakpointParams: SwiperOptions,
        ) => void;
        _containerClasses?: (swiper: Swiper, classNames: string) => void;
        _freeModeNoMomentumRelease?: (swiper: Swiper) => void;
        _freeModeStaticRelease?: () => void;
        _slideClass?: (
            swiper: Swiper,
            slideEl: HTMLElement,
            classNames: string,
        ) => void;
        _slideClasses?: (
            swiper: Swiper,
            slides: { classNames: string; index: number; slideEl: HTMLElement }[],
        ) => void;
        _swiper?: (swiper: Swiper) => void;
        activeIndexChange: (swiper: Swiper) => void;
        afterInit: (swiper: Swiper) => void;
        autoplay: (swiper: Swiper) => void;
        autoplayPause: (swiper: Swiper) => void;
        autoplayResume: (swiper: Swiper) => void;
        autoplayStart: (swiper: Swiper) => void;
        autoplayStop: (swiper: Swiper) => void;
        autoplayTimeLeft: (
            swiper: Swiper,
            timeLeft: number,
            percentage: number,
        ) => void;
        beforeDestroy: (swiper: Swiper) => void;
        beforeInit: (swiper: Swiper) => void;
        beforeLoopFix: (swiper: Swiper) => void;
        beforeResize: (swiper: Swiper) => void;
        beforeSlideChangeStart: (swiper: Swiper) => void;
        beforeTransitionStart: (
            swiper: Swiper,
            speed: number,
            internal: unknown,
        ) => void;
        breakpoint: (swiper: Swiper, breakpointParams: SwiperOptions) => void;
        changeDirection: (swiper: Swiper) => void;
        click: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        destroy: (swiper: Swiper) => void;
        doubleClick: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        doubleTap: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        fromEdge: (swiper: Swiper) => void;
        hashChange: (swiper: Swiper) => void;
        hashSet: (swiper: Swiper) => void;
        init: (swiper: Swiper) => any;
        keyPress: (swiper: Swiper, keyCode: string) => void;
        lock: (swiper: Swiper) => void;
        loopFix: (swiper: Swiper) => void;
        momentumBounce: (swiper: Swiper) => void;
        navigationHide: (swiper: Swiper) => void;
        navigationNext: (swiper: Swiper) => void;
        navigationPrev: (swiper: Swiper) => void;
        navigationShow: (swiper: Swiper) => void;
        observerUpdate: (swiper: Swiper) => void;
        orientationchange: (swiper: Swiper) => void;
        paginationHide: (swiper: Swiper) => void;
        paginationRender: (swiper: Swiper, paginationEl: HTMLElement) => void;
        paginationShow: (swiper: Swiper) => void;
        paginationUpdate: (swiper: Swiper, paginationEl: HTMLElement) => void;
        progress: (swiper: Swiper, progress: number) => void;
        reachBeginning: (swiper: Swiper) => void;
        reachEnd: (swiper: Swiper) => void;
        realIndexChange: (swiper: Swiper) => void;
        resize: (swiper: Swiper) => void;
        scroll: (swiper: Swiper, event: WheelEvent) => void;
        scrollbarDragEnd: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        scrollbarDragMove: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        scrollbarDragStart: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        setTransition: (
            swiper: Swiper,
            transition: number,
            byController?: boolean | Swiper,
        ) => void;
        setTranslate: (
            swiper: Swiper,
            translate: number,
            byController?: boolean | Swiper,
        ) => void;
        slideChange: (swiper: Swiper) => void;
        slideChangeTransitionEnd: (swiper: Swiper) => void;
        slideChangeTransitionStart: (swiper: Swiper) => void;
        slideNextTransitionEnd: (swiper: Swiper) => void;
        slideNextTransitionStart: (swiper: Swiper) => void;
        slidePrevTransitionEnd: (swiper: Swiper) => void;
        slidePrevTransitionStart: (swiper: Swiper) => void;
        slideResetTransitionEnd: (swiper: Swiper) => void;
        slideResetTransitionStart: (swiper: Swiper) => void;
        sliderFirstMove: (swiper: Swiper, event: TouchEvent) => void;
        sliderMove: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        slidesGridLengthChange: (swiper: Swiper) => void;
        slidesLengthChange: (swiper: Swiper) => void;
        slidesUpdated: (swiper: Swiper) => void;
        snapGridLengthChange: (swiper: Swiper) => void;
        snapIndexChange: (swiper: Swiper) => void;
        tap: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        toEdge: (swiper: Swiper) => void;
        touchEnd: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        touchMove: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        touchMoveOpposite: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        touchStart: (
            swiper: Swiper,
            event: PointerEvent | MouseEvent | TouchEvent,
        ) => void;
        transitionEnd: (swiper: Swiper) => void;
        transitionStart: (swiper: Swiper) => void;
        unlock: (swiper: Swiper) => void;
        update: (swiper: Swiper) => void;
        virtualUpdate: (swiper: Swiper) => void;
        zoomChange: (
            swiper: Swiper,
            scale: number,
            imageEl: HTMLElement,
            slideEl: HTMLElement,
        ) => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _beforeBreakpoint? _containerClasses? _freeModeNoMomentumRelease? _freeModeStaticRelease? _slideClass? _slideClasses? _swiper? activeIndexChange afterInit autoplay autoplayPause autoplayResume autoplayStart autoplayStop autoplayTimeLeft beforeDestroy beforeInit beforeLoopFix beforeResize beforeSlideChangeStart beforeTransitionStart breakpoint changeDirection click destroy doubleClick doubleTap fromEdge hashChange hashSet init keyPress lock loopFix momentumBounce navigationHide navigationNext navigationPrev navigationShow observerUpdate orientationchange paginationHide paginationRender paginationShow paginationUpdate progress reachBeginning reachEnd realIndexChange resize scroll scrollbarDragEnd scrollbarDragMove scrollbarDragStart setTransition setTranslate slideChange slideChangeTransitionEnd slideChangeTransitionStart slideNextTransitionEnd slideNextTransitionStart slidePrevTransitionEnd slidePrevTransitionStart slideResetTransitionEnd slideResetTransitionStart sliderFirstMove sliderMove slidesGridLengthChange slidesLengthChange slidesUpdated snapGridLengthChange snapIndexChange tap toEdge touchEnd touchMove touchMoveOpposite touchStart transitionEnd transitionStart unlock update virtualUpdate zoomChange

    Properties

    Optional_beforeBreakpoint

    _beforeBreakpoint?: (swiper: Swiper, breakpointParams: SwiperOptions) => void

    !INTERNAL: Event will fired right before breakpoint change

    Optional_containerClasses

    _containerClasses?: (swiper: Swiper, classNames: string) => void

    !INTERNAL: Event will fired after setting CSS classes on swiper container element

    Optional_freeModeNoMomentumRelease

    _freeModeNoMomentumRelease?: (swiper: Swiper) => void

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

    Optional_freeModeStaticRelease

    _freeModeStaticRelease?: () => void

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

    Optional_slideClass

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

    !INTERNAL: Event will fired after setting CSS classes on swiper slide element

    Optional_slideClasses

    _slideClasses?: (
        swiper: Swiper,
        slides: { classNames: string; index: number; slideEl: HTMLElement }[],
    ) => void

    !INTERNAL: Event will fired after setting CSS classes on all swiper slides

    Optional_swiper

    _swiper?: (swiper: Swiper) => void

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

    activeIndexChange: (swiper: Swiper) => void

    Event will fired on active index change

    afterInit: (swiper: Swiper) => void

    Event will fired right after initialization

    autoplay: (swiper: Swiper) => void

    Event will be fired when slide changed with autoplay

    autoplayPause: (swiper: Swiper) => void

    Event will be fired on autoplay pause

    autoplayResume: (swiper: Swiper) => void

    Event will be fired on autoplay resume

    autoplayStart: (swiper: Swiper) => void

    Event will be fired in when autoplay started

    autoplayStop: (swiper: Swiper) => void

    Event will be fired when autoplay stopped

    autoplayTimeLeft: (swiper: Swiper, timeLeft: number, percentage: number) => void

    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

    beforeDestroy: (swiper: Swiper) => void

    Event will be fired right before Swiper destroyed

    beforeInit: (swiper: Swiper) => void

    Event will fired right before initialization

    beforeLoopFix: (swiper: Swiper) => void

    Event will be fired right before "loop fix"

    beforeResize: (swiper: Swiper) => void

    Event will fired before resize handler

    beforeSlideChangeStart: (swiper: Swiper) => void

    Event will fired before slide change transition start

    beforeTransitionStart: (
        swiper: Swiper,
        speed: number,
        internal: unknown,
    ) => void

    Event will fired before transition start

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

    Event will be fired on breakpoint change

    changeDirection: (swiper: Swiper) => void

    Event will fired on direction change

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

    Event will be fired when user click/tap on Swiper. Receives pointerup event as an arguments.

    destroy: (swiper: Swiper) => void

    Event will be fired on swiper destroy

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

    Event will be fired when user double click/tap on Swiper

    doubleTap: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired when user double tap on Swiper's container. Receives pointerup event as an arguments

    fromEdge: (swiper: Swiper) => void

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

    hashChange: (swiper: Swiper) => void

    Event will be fired on window hash change

    hashSet: (swiper: Swiper) => void

    Event will be fired when swiper updates the hash

    init: (swiper: Swiper) => any

    Fired right after Swiper initialization.

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

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

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

    Event will be fired on key press

    lock: (swiper: Swiper) => void

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

    loopFix: (swiper: Swiper) => void

    Event will be fired after "loop fix"

    momentumBounce: (swiper: Swiper) => void

    Event will be fired on momentum bounce

    navigationHide: (swiper: Swiper) => void

    Event will be fired on navigation hide

    navigationNext: (swiper: Swiper) => void

    Event will be fired on navigation next button click

    navigationPrev: (swiper: Swiper) => void

    Event will be fired on navigation prev button click

    navigationShow: (swiper: Swiper) => void

    Event will be fired on navigation show

    observerUpdate: (swiper: Swiper) => void

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

    orientationchange: (swiper: Swiper) => void

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

    paginationHide: (swiper: Swiper) => void

    Event will be fired on pagination hide

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

    Event will be fired after pagination rendered

    paginationShow: (swiper: Swiper) => void

    Event will be fired on pagination show

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

    Event will be fired when pagination updated

    progress: (swiper: Swiper, 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

    reachBeginning: (swiper: Swiper) => void

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

    reachEnd: (swiper: Swiper) => void

    Event will be fired when Swiper reach last slide

    realIndexChange: (swiper: Swiper) => void

    Event will fired on real index change

    resize: (swiper: Swiper) => void

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

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

    Event will be fired on mousewheel scroll

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

    Event will be fired on draggable scrollbar drag end

    scrollbarDragMove: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired on draggable scrollbar drag move

    scrollbarDragStart: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired on draggable scrollbar drag start

    setTransition: (
        swiper: Swiper,
        transition: number,
        byController?: boolean | Swiper,
    ) => void

    Event will be fired everytime when swiper starts animation. Receives current transition duration (in ms) as an arguments. The optional third argument is set by the Controller module to short-circuit re-propagation between linked Swipers.

    setTranslate: (
        swiper: Swiper,
        translate: number,
        byController?: boolean | Swiper,
    ) => void

    Event will be fired when swiper's wrapper change its position. Receives current translate value as an arguments. The optional third argument is set by the Controller module to short-circuit re-propagation between linked Swipers.

    slideChange: (swiper: Swiper) => void

    Event will be fired when currently active slide is changed

    slideChangeTransitionEnd: (swiper: Swiper) => void

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

    slideChangeTransitionStart: (swiper: Swiper) => void

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

    slideNextTransitionEnd: (swiper: Swiper) => void

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

    slideNextTransitionStart: (swiper: Swiper) => void

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

    slidePrevTransitionEnd: (swiper: Swiper) => void

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

    slidePrevTransitionStart: (swiper: Swiper) => void

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

    slideResetTransitionEnd: (swiper: Swiper) => void

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

    slideResetTransitionStart: (swiper: Swiper) => void

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

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

    Event will be fired with first touch/drag move

    sliderMove: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired when user touch and move finger over Swiper and move it. Receives pointermove event as an arguments.

    slidesGridLengthChange: (swiper: Swiper) => void

    Event will be fired when slides grid has changed

    slidesLengthChange: (swiper: Swiper) => void

    Event will be fired when number of slides has changed

    slidesUpdated: (swiper: Swiper) => void

    Event will be fired after slides and their sizes are calculated and updated

    snapGridLengthChange: (swiper: Swiper) => void

    Event will be fired when snap grid has changed

    snapIndexChange: (swiper: Swiper) => void

    Event will fired on snap index change

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

    Event will be fired when user click/tap on Swiper. Receives pointerup event as an arguments.

    toEdge: (swiper: Swiper) => void

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

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

    Event will be fired when user release Swiper. Receives pointerup event as an arguments.

    touchMove: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired when user touch and move finger over Swiper. Receives pointermove event as an arguments.

    touchMoveOpposite: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired when user touch and move finger over Swiper in direction opposite to direction parameter. Receives pointermove event as an arguments.

    touchStart: (
        swiper: Swiper,
        event: PointerEvent | MouseEvent | TouchEvent,
    ) => void

    Event will be fired when user touch Swiper. Receives pointerdown event as an arguments.

    transitionEnd: (swiper: Swiper) => void

    Event will be fired after transition.

    transitionStart: (swiper: Swiper) => void

    Event will be fired in the beginning of transition.

    unlock: (swiper: Swiper) => void

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

    update: (swiper: Swiper) => void

    Event will be fired after swiper.update() call

    virtualUpdate: (swiper: Swiper) => void

    Event will be fired after the virtual slides DOM has been re-rendered (either internally by the module or after a renderExternal round-trip).

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

    Event will be fired on zoom change

    Settings

    Member Visibility

    On This Page

    Properties
    _beforeBreakpoint_containerClasses_freeModeNoMomentumRelease_freeModeStaticRelease_slideClass_slideClasses_swiperactiveIndexChangeafterInitautoplayautoplayPauseautoplayResumeautoplayStartautoplayStopautoplayTimeLeftbeforeDestroybeforeInitbeforeLoopFixbeforeResizebeforeSlideChangeStartbeforeTransitionStartbreakpointchangeDirectionclickdestroydoubleClickdoubleTapfromEdgehashChangehashSetinitkeyPresslockloopFixmomentumBouncenavigationHidenavigationNextnavigationPrevnavigationShowobserverUpdateorientationchangepaginationHidepaginationRenderpaginationShowpaginationUpdateprogressreachBeginningreachEndrealIndexChangeresizescrollscrollbarDragEndscrollbarDragMovescrollbarDragStartsetTransitionsetTranslateslideChangeslideChangeTransitionEndslideChangeTransitionStartslideNextTransitionEndslideNextTransitionStartslidePrevTransitionEndslidePrevTransitionStartslideResetTransitionEndslideResetTransitionStartsliderFirstMovesliderMoveslidesGridLengthChangeslidesLengthChangeslidesUpdatedsnapGridLengthChangesnapIndexChangetaptoEdgetouchEndtouchMovetouchMoveOppositetouchStarttransitionEndtransitionStartunlockupdatevirtualUpdatezoomChange