Swiper API

Set to false to disable swiping to next slide direction (to right or bottom)

Set to false to disable swiping to previous slide direction (to left or top)

If false, then the only way to switch the slide is use of external API functions like slidePrev or slideNext

Set to true and slider wrapper will adapt its height to the height of the currently active slide

Allows to set different parameter for different responsive breakpoints (screen sizes). Not all parameters can be changed in breakpoints, only those which do not require different layout and logic, like slidesPerView, slidesPerGroup, spaceBetween, grid.rows. Such parameters like loop and effect won't work

const swiper = new Swiper('.swiper', {
  // Default parameters
  slidesPerView: 1,
  spaceBetween: 10,
  // Responsive breakpoints
  breakpoints: {
    // when window width is >= 320px
    320: {
      slidesPerView: 2,
      spaceBetween: 20
    },
    // when window width is >= 480px
    480: {
      slidesPerView: 3,
      spaceBetween: 30
    },
    // when window width is >= 640px
    640: {
      slidesPerView: 4,
      spaceBetween: 40
    }
  }
})

const swiper = new Swiper('.swiper', {
  slidesPerView: 1,
  spaceBetween: 10,
  // using "ratio" endpoints
  breakpoints: {
    '@0.75': {
      slidesPerView: 2,
      spaceBetween: 20,
    },
    '@1.00': {
      slidesPerView: 3,
      spaceBetween: 40,
    },
    '@1.50': {
      slidesPerView: 4,
      spaceBetween: 50,
    },
  }
});

Base for breakpoints (beta). Can be window or container. If set to window (by default) then breakpoint keys mean window width. If set to container then breakpoint keys treated as swiper container width

Currently in beta and not supported by Swiper Angular, React, Svelte and Vue components

When enabled it center slides if the amount of slides less than slidesPerView. Not intended to be used loop mode and grid.rows

If true, then active slide will be centered, not always on the left side.

If true, then active slide will be centered without adding gaps at the beginning and end of slider. Required centeredSlides: true. Not intended to be used with loop or pagination

The beginning of the modifier CSS class that can be added to swiper container depending on different parameters

When enabled Swiper will automatically wrap slides with swiper-wrapper element, and will create required elements for navigation, pagination and scrollbar they are enabled (with their respective params object or with boolean true))

When enabled it will use modern CSS Scroll Snap API. It doesn't support all of Swiper's features, but potentially should bring a much better performance in simple configurations.

This is what is not supported when it is enabled:

• Cube and Cards effects
• speed parameter may not have no effect
• All transition start/end related events (use slideChange instead)
• slidesPerGroup has limited support
• simulateTouch doesn't have effect and "dragging" with mouse doesn't work
• resistance doesn't have any effect
• allowSlidePrev/Next
• swipeHandler
• freeMode and all relevant features

Can be 'horizontal' or 'vertical' (for vertical slider).

Enable to release Swiper events for swipe-back work in app. If set to 'prevent' then it will prevent system swipe-back navigation instead

Area (in px) from left edge of the screen to release touch events for swipe-back in app

Transition effect. Can be 'slide', 'fade', 'cube', 'coverflow', 'flip' or 'creative'

Whether Swiper initially enabled. When Swiper is disabled, it will hide all navigation elements and won't respond to any events and interactions

CSS selector for focusable elements. Swiping will be disabled on such elements if they are "focused"

If disabled, then slider will be animated only when you release it, it will not move while you hold your finger on it

This option may a little improve desktop usability. If true, user will see the "grab" cursor when hover on Swiper

Swiper height (in px). Parameter allows to force Swiper height. Useful only if you initialize Swiper when it is hidden and in SSR and Test environments for correct Swiper initialization

Setting this parameter will make Swiper not responsive

Whether Swiper should be initialised automatically when you create an instance. If disabled, then you need to init it manually by calling swiper.init()

Index number of initial slide.

Set to false if you want to disable long swipes

Minimal duration (in ms) to trigger swipe to next/previous slide during long swipes

Ratio to trigger swipe to next/previous slide during long swipes

Set to true to enable continuous loop mode

Because of nature of how the loop mode works, it will add duplicated slides. Such duplicated slides will have additional classes:

• swiper-slide-duplicate - represents duplicated slide
• swiper-slide-duplicate-active - represents slide duplicated to the currently active slide
• swiper-slide-duplicate-next - represents slide duplicated to the slide next to active
• swiper-slide-duplicate-prev - represents slide duplicated to the slide previous to active

If you use it along with slidesPerView: 'auto' then you need to specify loopedSlides parameter with amount of slides to loop (duplicate). Should not be used together with rewind mode

Addition number of slides that will be cloned after creating of loop

Enable and loop mode will fill groups with insufficient number of slides with blank slides. Good to be used with slidesPerGroup parameter

When enabled it prevents Swiper slide prev/next transitions when transitions is already in progress (has effect when loop enabled)

If you use slidesPerView:'auto' with loop mode you should tell to Swiper how many slides it should loop (duplicate) using this parameter

When enabled then amount of duplicated slides will not exceed amount of original slides. Useful to disable and increase loopedSlides when you have a lot of slides per view and not sufficient amount of original slides

If total number of slides less than specified here value, then Swiper will enable backface-visibility: hidden on slide elements to reduce visual "flicker" in Safari.

It is not recommended to enable it on large amount of slides as it will reduce performance

Array with Swiper modules

import Swiper, { Navigation, Pagination } from 'swiper';

const swiper = new Swiper('.swiper', {
   modules: [ Navigation, Pagination ],
 });

Set to true on Swiper for correct touch events interception. Use only on swipers that use same direction as the parent one

Enable/disable swiping on elements matched to class specified in noSwipingClass

Specify noSwiping's element css class

Can be used instead of noSwipingClass to specify elements to disable swiping on. For example 'input' will disable swiping on all inputs

Normalize slide index.

Set to true if you also need to watch Mutations for Swiper parent elements

Set to true if you also need to watch Mutations for Swiper slide children elements

Set to true to enable Mutation Observer on Swiper and its elements. In this case Swiper will be updated (reinitialized) each time if you change its style (like hide/show) or modify its child elements (like adding/removing slides)

Register event handlers

Passive event listeners will be used by default where possible to improve scrolling performance on mobile devices. But if you need to use e.preventDefault and you have conflict with it, then you should disable this parameter

When enabled Swiper will force to load all images

Set to true to prevent accidental unwanted clicks on links during swiping

Set to true to stop clicks event propagation on links during swiping

When enabled it won't allow to change slides by swiping or navigation/pagination buttons during transition

Set to false if you want to disable resistant bounds

This option allows you to control resistance ratio

When enabled it will use ResizeObserver (if supported by browser) on swiper container to detect container resize (instead of watching for window resize)

Set to true to enable "rewind" mode. When enabled, clicking "next" navigation button (or calling .slideNext()) when on last slide will slide back to the first slide. Clicking "prev" navigation button (or calling .slidePrev()) when on first slide will slide forward to the last slide.

Should not be used together with loop mode

Set to true to round values of slides width and height to prevent blurry texts on usual resolution screens (if you have such)

Fire Transition/SlideChange/Start/End events on swiper initialization. Such events will be fired on initialization in case of your initialSlide is not 0, or you use loop mode

Enabled this option and plugin will set width/height on swiper wrapper equal to total size of all slides. Mostly should be used as compatibility fallback option for browser that don't support flexbox layout well

Set to false if you want to disable short swipes

If true, Swiper will accept mouse events like touch events (click and drag to change slides)

CSS class name of currently active slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue components

CSS class name of blank slide append to fill groups in loop mode when loopFillGroupWithBlank is also enabled

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

CSS class name of slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue components

CSS class name of duplicated slide which represents the currently active slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue components

CSS class name of slide duplicated by loop mode

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

CSS class name of duplicated slide which represents the slide next to active slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

CSS class name of duplicated slide which represents the slide previous to active slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

CSS class name of slide which is right after currently active slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

CSS class name of slide which is right before currently active slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

Set to true and click on any slide will produce transition to this slide

CSS class name of currently visible slide

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

Add (in px) additional slide offset in the end of the container (after all slides)

Add (in px) additional slide offset in the beginning of the container (before all slides)

Set numbers of slides to define and enable group sliding. Useful to use with slidesPerView > 1

This param intended to be used only with slidesPerView: 'auto' and slidesPerGroup: 1. When enabled, it will skip all slides in view on .slideNext() & .slidePrev() methods calls, on Navigation "buttons" clicks and in autoplay.

The parameter works in the following way: If slidesPerGroupSkip equals 0 (default), no slides are excluded from grouping, and the resulting behaviour is the same as without this change.

If slidesPerGroupSkip is equal or greater than 1 the first X slides are treated as single groups, whereas all following slides are grouped by the slidesPerGroup value.

Number of slides per view (slides visible at the same time on slider's container).

If you use it with "auto" value and along with loop: true then you need to specify loopedSlides parameter with amount of slides to loop (duplicate)

slidesPerView: 'auto' is currently not compatible with multirow mode, when grid.rows > 1

Distance between slides in px.

If you use "margin" css property to the elements which go into Swiper in which you pass "spaceBetween" into, navigation might not work properly.

Duration of transition between slides (in ms)

String with CSS selector or HTML element of the container with pagination that will work as only available handler for swiping

Threshold value in px. If "touch distance" will be lower than this value then swiper will not move

Allowable angle (in degrees) to trigger touch move

Target element to listen touch events on. Can be 'container' (to listen for touch events on swiper) or 'wrapper'(to listen for touch events on swiper-wrapper)

If enabled, then propagation of "touchmove" will be stopped

Touch ratio

Enable to release touch events on slider edge position (beginning, end) to allow for further page scrolling

Force to always prevent default for touchstart (pointerdown) event

If disabled, touchstart (pointerdown) event won't be prevented

If enabled (by default) and navigation elements' parameters passed as a string (like ".pagination") then Swiper will look for such elements through child elements first. Applies for pagination, prev/next buttons and scrollbar elements

When enabled Swiper will be reinitialized after all inner images ( tags) are loaded. Required preloadImages: true

Swiper will recalculate slides position on window resize (orientationchange)

Required for active slide detection when rendered on server-side and enabled history

userAgent string. Required for browser/device detection when rendered on server-side

Enabled this option and swiper will be operated as usual except it will not move, real translate values on wrapper will not be set. Useful when you may need to create custom slide transition

When enabled Swiper will be disabled and hide navigation buttons on case there are not enough slides for sliding.

Enable this feature to calculate each slides progress and visibility (slides in viewport will have additional visible class)

Swiper width (in px). Parameter allows to force Swiper width. Useful only if you initialize Swiper when it is hidden and in SSR and Test environments for correct Swiper initialization

Setting this parameter will make Swiper not responsive

CSS class name of slides' wrapper

By changing classes you will also need to change Swiper's CSS to reflect changed classes

Not supported in Swiper Angular/React/Svelte/Vue

Add event listener that will be fired on all events

const swiper = new Swiper('.swiper', {
   onAny(eventName, ...args) {
     console.log('Event: ', eventName);
     console.log('Event data: ', args);
   }
 });

Object with navigation parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  navigation: {
    nextEl: '.swiper-button-next',
    prevEl: '.swiper-button-prev',
  },
});

Object with pagination parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  pagination: {
    el: '.swiper-pagination',
    type: 'bullets',
  },
});

Object with scrollbar parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  scrollbar: {
    el: '.swiper-scrollbar',
    draggable: true,
  },
});

Object with autoplay parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
 autoplay: {
   delay: 5000,
 },
});

Enables free mode functionality. Object with free mode parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  freeMode: true,
});

const swiper = new Swiper('.swiper', {
  freeMode: {
    enabled: true,
    sticky: true,
  },
});

Object with grid parameters to enable "multirow" slider.

const swiper = new Swiper('.swiper', {
  grid: {
    rows: 2,
  },
});

Object with parallax parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  parallax: true,
});

Enables images lazy loading. Object with lazy loading parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  lazy: {
    loadPrevNext: true,
  },
});

Object with Fade-effect parameters

const swiper = new Swiper('.swiper', {
  effect: 'fade',
  fadeEffect: {
    crossFade: true
  },
});

Object with Coverflow-effect parameters.

const swiper = new Swiper('.swiper', {
  effect: 'coverflow',
  coverflowEffect: {
    rotate: 30,
    slideShadows: false,
  },
});

Object with Flip-effect parameters

const swiper = new Swiper('.swiper', {
  effect: 'flip',
  flipEffect: {
    slideShadows: false,
  },
});

Object with Cube-effect parameters

const swiper = new Swiper('.swiper', {
  effect: 'cube',
  cubeEffect: {
    slideShadows: false,
  },
});

Object with Cards-effect parameters

const swiper = new Swiper('.swiper', {
  effect: 'cards',
  cardsEffect: {
    // ...
  },
});

Object with Creative-effect parameters

const swiper = new Swiper('.swiper', {
  effect: 'creative',
  creativeEffect: {
    prev: {
      // will set `translateZ(-400px)` on previous slides
      translate: [0, 0, -400],
    },
    next: {
      // will set `translateX(100%)` on next slides
      translate: ['100%', 0, 0],
    },
  },
});

Object with thumbs component parameters

const swiper = new Swiper('.swiper', {
  ...
  thumbs: {
    swiper: thumbsSwiper
  }
});

Enables zooming functionality. Object with zoom parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  zoom: {
    maxRatio: 5,
  },
});

Enables navigation through slides using keyboard. Object with keyboard parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  keyboard: {
    enabled: true,
    onlyInViewport: false,
  },
});

Enables navigation through slides using mouse wheel. Object with mousewheel parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  mousewheel: {
    invert: true,
  },
});

Enables virtual slides functionality. Object with virtual slides parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  virtual: {
    slides: ['Slide 1', 'Slide 2', 'Slide 3', 'Slide 4', 'Slide 5'],
  },
});

Enables hash url navigation to for slides. Object with hash navigation parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  hashNavigation: {
    replaceState: true,
  },
});

Enables history push state where every slide will have its own url. In this parameter you have to specify main slides url like "slides" and specify every slide url using data-history attribute.

Object with history navigation parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  history: {
    replaceState: true,
  },
});

<!-- will produce "slides/slide1" url in browser history -->
<div class="swiper-slide" data-history="slide1"></div>

Object with controller parameters or boolean true to enable with default settings

const swiper = new Swiper('.swiper', {
  controller: {
    inverse: true,
  },
});

Object with a11y parameters or boolean true to enable with default settings.

const swiper = new Swiper('.swiper', {
  a11y: {
    prevSlideMessage: 'Previous slide',
    nextSlideMessage: 'Next slide',
  },
});