刷卡API

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

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

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

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

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

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

Object with Cards-effect parameters

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

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

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

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

Object with Coverflow-effect parameters.

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

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))

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],
    },
  },
});

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 effect
• 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

In case if you use it with other effects, especially 3D effects, it is required to wrap slide's content with <div className="swiper-slide-transform"> element. And if you use any custom styles on slides (like background colors, border radius, border, etc.), they should be set on swiper-slide-transform element instead.

<div class="swiper">
  <div class="swiper-wrapper">
    <div class="swiper-slide">
      <!-- wrap slide content with transform element -->
      <div class="swiper-slide-transform">
        ... slide content ...
      </div>
    </div>
    ...
  </div>
</div>
<script>
const swiper = new Swiper('.swiper', {
   effect: 'flip',
   cssMode: true,
 });
</script>

Object with Cube-effect parameters

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

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. This feature works only with "touch" events (and not pointer events), so it will work on iOS/Android devices and won't work on Windows devices with pointer (touch) events.

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', 'creative' or 'cards'

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

Event name prefix for all DOM events emitted by Swiper Element (web component)

Object with Fade-effect parameters

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

Object with Flip-effect parameters

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

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

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,
  },
});

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

Object with grid parameters to enable "multirow" slider.

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

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,
  },
});

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

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>

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.

Inject text styles to the shadow DOM. Only for usage with Swiper Element

Inject styles <link>s to the shadow DOM. Only for usage with Swiper Element

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,
  },
});

Number of next and previous slides to preload. Only applicable if using lazy loading.

CSS class name of lazy preloader

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 rearrange slides), total number of slides must be:

• more than or equal to slidesPerView + slidesPerGroup
• even to slidesPerGroup (or use loopAddBlankSlides parameter)
• even to grid.rows (or use loopAddBlankSlides parameter)

Automatically adds blank slides if you use Grid or slidesPerGroup and the total amount of slides is not even to slidesPerGroup or to grid.rows

Allows to increase amount of looped slides

If enabled then slideNext/Prev will do nothing while slider is animating in loop mode

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 from 'swiper';
import { Navigation, Pagination } from 'swiper/modules';

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

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,
  },
});

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',
  },
});

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

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);
   }
 });

When enabled, will swipe slides only forward (one-way) regardless of swipe direction

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 parallax parameters or boolean true to enable with default settings.

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

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

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

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

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

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 React/Vue components

CSS class name of the blank slide added by the loop mode (when loopAddBlankSlides is enabled)

Not supported in Swiper React/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 React/Vue components

CSS class name of fully (when whole slide is in the viewport) visible slide

Not supported in Swiper React/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 React/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 React/Vue

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

CSS class name of currently/partially visible slide

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

Not supported in Swiper React/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).

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

The name of the swiper element node name; used for detecting web component rendering

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

Object with thumbs component parameters

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

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. This feature works only with "touch" events (and not pointer events), so it will work on iOS/Android devices and won't work on Windows devices with pointer events. Also threshold parameter must be set to 0

Force to always prevent default for touchstart (pointerdown) event

If disabled, 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

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

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'],
  },
});

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 React/Vue

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

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

CSS class name added to navigation button when it becomes disabled

Boolean property to use with breakpoints to enable/disable navigation on certain breakpoints

CSS class name added to navigation button when it becomes hidden

Toggle navigation buttons visibility after click on Slider's container

CSS class name added to navigation button when it is disabled

CSS class name added on swiper container when navigation is disabled by breakpoint

String with CSS selector or HTML element of the element that will work like "next" button after click on it

String with CSS selector or HTML element of the element that will work like "prev" button after click on it

CSS class name of currently active pagination bullet

CSS class name of single pagination bullet

Defines which HTML tag will be used to represent single pagination bullet. Only for 'bullets' pagination type.

If true then clicking on pagination button will cause transition to appropriate slide. Only for bullets pagination type

CSS class name set to pagination when it is clickable

CSS class name of the element with currently active index in "fraction" pagination

Good to enable if you use bullets pagination with a lot of slides. So it will keep only few bullets visible at the same time.

The number of main bullets visible when dynamicBullets enabled.

String with CSS selector or HTML element of the container with pagination

Boolean property to use with breakpoints to enable/disable pagination on certain breakpoints

format fraction pagination current number. Function receives current number, and you need to return formatted value

format fraction pagination total number. Function receives total number, and you need to return formatted value

CSS class name of pagination when it becomes inactive

Toggle (hide/show) pagination container visibility after click on Slider's container

CSS class name set to pagination in horizontal Swiper

CSS class name set to pagination when it is disabled

The beginning of the modifier CSS class name that will be added to pagination depending on parameters

CSS class name added on swiper container and pagination element when pagination is disabled by breakpoint

CSS class name of pagination progressbar fill element

Makes pagination progressbar opposite to Swiper's direction parameter, means vertical progressbar for horizontal swiper direction and horizontal progressbar for vertical swiper direction

CSS class name of pagination progressbar opposite

This parameter allows totally customize pagination bullets, you need to pass here a function that accepts index number of pagination bullet and required element class name (className). Only for 'bullets' pagination type

const swiper = new Swiper('.swiper', {
  //...
  pagination: {
    //...
    renderBullet: function (index, className) {
      return '<span class="' + className + '">' + (index + 1) + '</span>';
    },
  },
});

This parameter is required for 'custom' pagination type where you have to specify how it should be rendered.

const swiper = new Swiper('.swiper', {
  //...
  pagination: {
    //...
    renderCustom: function (swiper, current, total) {
      return current + ' of ' + total;
    },
  },
});

This parameter allows to customize "fraction" pagination html. Only for 'fraction' pagination type

const swiper = new Swiper('.swiper', {
  //...
  pagination: {
    //...
    renderFraction: function (currentClass, totalClass) {
      return '<span class="' + currentClass + '"></span>' +
              ' of ' +
              '<span class="' + totalClass + '"></span>';
    },
  },
});

This parameter allows to customize "progress" pagination. Only for 'progress' pagination type

const swiper = new Swiper('.swiper', {
  //...
  pagination: {
    //...
    renderProgressbar: function (progressbarFillClass) {
      return '<span class="' + progressbarFillClass + '"></span>';
    },
  },
});

CSS class name of the element with total number of "snaps" in "fraction" pagination

String with type of pagination. Can be 'bullets', 'fraction', 'progressbar' or 'custom'

CSS class name set to pagination in vertical Swiper

Scrollbar draggable element CSS class

Size of scrollbar draggable element in px

Set to true to enable make scrollbar draggable that allows you to control slider position

String with CSS selector or HTML element of the container with scrollbar.

Boolean property to use with breakpoints to enable/disable scrollbar on certain breakpoints

Hide scrollbar automatically after user interaction

CSS class name set to scrollbar in horizontal Swiper

Scrollbar element additional CSS class when it is disabled

CSS class name added on swiper container and scrollbar element when scrollbar is disabled by breakpoint

Set to true to snap slider position to slides when you release scrollbar

CSS class name set to scrollbar in vertical Swiper

Delay between transitions (in ms). If this parameter is not specified, auto play will be disabled

If you need to specify different delay for specific slides you can do it by usingdata-swiper-autoplay (in ms) attribute on slide.

<!-- hold this slide for 2 seconds -->
<div class="swiper-slide" data-swiper-autoplay="2000">

Set to false and autoplay will not be disabled after user interactions (swipes), it will be restarted every time after interaction

When enabled autoplay will be paused on pointer (mouse) enter over Swiper container.

Enables autoplay in reverse direction

Enable this parameter and autoplay will be stopped when it reaches last slide (has no effect in loop mode)

When enabled autoplay will wait for wrapper transition to continue. Can be disabled in case of using Virtual Translate when your slider may not have transition

Whether the free mode is enabled

Minimum touchmove-velocity required to trigger free mode momentum

If enabled, then slide will keep moving for a while after you release it

Set to false if you want to disable momentum bounce in free mode

Higher value produces larger momentum bounce effect

Higher value produces larger momentum distance after you release slider

Higher value produces larger momentum velocity after you release slider

Set to enabled to enable snap to slides positions in free mode

Can be 'column' or 'row'. Defines how slides should fill rows, by column or by row

if used with loop mode make sure number of slides is even specified in loop mode requirements, or enable loopAddBlankSlides parameter

Number of slides rows, for multirow layout

Enable, if you want to use "parallaxed" elements inside of slider

Enables slides cross fade

Depth offset in px (slides translate in Z axis)

Effect multiplier

Slide rotate in degrees

Slide scale effect

Enables slides shadows

Stretch space between slides (in px)

Limit edge slides rotation

Enables slides shadows

Enables main slider shadow

Main shadow offset in px

Main shadow scale ratio

Enables slides shadows

Offset distance per slide (in px)

Rotate angle per slide (in degrees)

Enables cards rotation

Enables slides shadows

Limit progress/offset to amount of side slides. If 1, then slides all slides after prev/next will have same state. If 2, then all slides after 2nd before/after active will have same state, etc.

Next slide transformations.

{
  // Array with translate X, Y and Z values
  translate: (string | number)[];
  // Array with rotate X, Y and Z values (in deg)
  rotate?: number[];
  // Slide opacity
  opacity?: number;
  // Slide scale
  scale?: number;
  // Enables slide shadow
  shadow?: boolean;
  // Transform origin, e.g. `left bottom`
  origin?: string;
}

Enable this parameter if your custom transforms require 3D transformations (translateZ, rotateX, rotateY )

Previous slide transformations. Accepts object of the following type:

{
  // Array with translate X, Y and Z values
  translate: (string | number)[];
  // Array with rotate X, Y and Z values (in deg)
  rotate?: number[];
  // Slide opacity
  opacity?: number;
  // Slide scale
  scale?: number;
  // Enables slide shadow
  shadow?: boolean;
  // Transform origin, e.g. `left bottom`
  origin?: string;
}

Allows to multiply slides transformations and opacity.

Splits shadow "opacity" per slide based on limitProgress (only if transformation shadows enabled). E.g. setting limitProgress: 2 and enabling shadowPerProgress, will set shadow opacity to 0.5 and 1 on two slides next to active. With this parameter disabled, all slides beside active will have shadow with 1 opacity

Allows to set on which thumbs active slide from edge it should automatically move scroll thumbs. For example, if set to 1 and last visible thumb will be activated (1 from edge) it will auto scroll thumbs

When enabled multiple thumbnail slides may get activated

Additional class that will be added to activated thumbs swiper slide

Swiper instance of swiper used as thumbs or object with Swiper parameters to initialize thumbs swiper

Additional class that will be added to thumbs swiper

CSS class name of zoom container

When set to true, the image will not be scaled past 100% of its original size

Maximum image zoom multiplier

Minimal image zoom multiplier

When set to true, a zoomed in image will automatically pan while moving the mouse over the image

Enable/disable zoom-in by slide's double tap

CSS class name of zoomed in container

Set to true to enable keyboard control

When enabled it will control sliders that are currently in viewport

When enabled it will enable keyboard navigation by Page Up and Page Down keys

Set to true to enable mousewheel control

String with CSS selector or HTML element of the container accepting mousewheel events. By default it is swiper

Set to true to force mousewheel swipes to axis. So in horizontal mode mousewheel will work only with horizontal mousewheel scrolling, and only with vertical scrolling in vertical mode.

Set to true to invert sliding direction

Scrolling on elements with this class will be ignored

Set to true and swiper will release mousewheel event and allow page scrolling when swiper is on edge positions (in the beginning or in the end)

Multiplier of mousewheel data, allows to tweak mouse wheel sensitivity

Minimum mousewheel scroll delta to trigger swiper slide change

Minimum mousewheel scroll time delta (in ms) to trigger swiper slide change

Increases amount of pre-rendered slides after active slide

Increases amount of pre-rendered slides before active slide

Enables DOM cache of rendering slides html elements. Once they are rendered they will be saved to cache and reused from it.

Whether the virtual slides are enabled

Function for external rendering (e.g. using some other library to handle DOM manipulations and state like React.js or Vue.js). As an argument it accepts data object with the following properties:

• offset - slides left/top offset in px
• from - index of first slide required to be rendered
• to - index of last slide required to be rendered
• slides - array with slide items to be rendered

When enabled (by default) it will update Swiper layout right after renderExternal called. Useful to disable and update swiper manually when used with render libraries that renders asynchronously

Function to render slide. As an argument it accepts current slide item for slides array and index number of the current slide. Function must return an outer HTML of the swiper slide or slide HTML element.

Array with slides

Designed to be used with Virtual slides when it is impossible to find slide in DOM by hash (e.g. not yet rendered)

Works in addition to hashnav to replace current url state with the new one instead of adding it to history

Set to true to enable also navigation through slides (when hashnav is enabled) by browser history or by setting directly hash on document location

Enables History Plugin.

Keep query parameters when changing browser url.

Url key for slides

Works in addition to hashnav or history to replace current url state with the new one instead of adding it to history

Swiper page root, useful to specify when you use Swiper history mode not on root website page. For example can be https://my-website.com/ or https://my-website.com/subpage/ or /subpage/

Defines a way how to control another slider: slide by slide (with respect to other slider's grid) or depending on all slides/container (depending on total slider percentage).

Pass here another Swiper instance or array with Swiper instances that should be controlled by this Swiper. Also accepts string with CSS selector of Swiper element, or HTMLElement of Swiper element

Set to true and controlling will be in inverse direction

Message for screen readers for outer swiper container

Value of the "role" attribute to be set on the swiper container

Message for screen readers describing the role of outer swiper container

Enables A11y

Message for screen readers for previous button when swiper is on first slide

Value of id attribute to be set on swiper-wrapper. If null will be generated automatically

Message for screen readers describing the role of slide element

Message for screen readers for next button when swiper is on last slide

Message for screen readers for next button

CSS class name of A11y notification

Message for screen readers for single pagination bullet

Message for screen readers for previous button

Enables scrolling to the slide that has been focused

Message for screen readers describing the label of slide element

Value of swiper slide role attribute