Interface SwiperOptions

interface SwiperOptions {
    _emitClasses?: boolean;
    _loopSwapReset?: boolean;
    allowSlideNext?: boolean;
    allowSlidePrev?: boolean;
    allowTouchMove?: boolean;
    autoHeight?: boolean;
    breakpoints?: {
        [width: number]: SwiperOptions;
        [ratio: string]: SwiperOptions;
    };
    breakpointsBase?: "container"
    | CSSSelector
    | "window";
    centeredSlides?: boolean;
    centeredSlidesBounds?: boolean;
    centerInsufficientSlides?: boolean;
    containerModifierClass?: string;
    createElements?: boolean;
    cssMode?: boolean;
    direction?: "horizontal" | "vertical";
    edgeSwipeDetection?: string | boolean;
    edgeSwipeThreshold?: number;
    effect?:
        | "slide"
        | "fade"
        | "cube"
        | "coverflow"
        | "flip"
        | "creative"
        | "cards"
        | string & {};
    enabled?: boolean;
    eventsPrefix?: string;
    focusableElements?: string;
    followFinger?: boolean;
    grabCursor?: boolean;
    height?: number
    | null;
    init?: boolean;
    initialSlide?: number;
    injectStyles?: string[];
    injectStylesUrls?: string[];
    lazyPreloaderClass?: string;
    lazyPreloadPrevNext?: number;
    longSwipes?: boolean;
    longSwipesMs?: number;
    longSwipesRatio?: number;
    loop?: boolean;
    loopAddBlankSlides?: boolean;
    loopAdditionalSlides?: number;
    loopPreventsSliding?: boolean;
    maxBackfaceHiddenSlides?: number;
    modules?: SwiperModule[];
    nested?: boolean;
    normalizeSlideIndex?: boolean;
    noSwiping?: boolean;
    noSwipingClass?: string;
    noSwipingSelector?: string;
    observeParents?: boolean;
    observer?: boolean;
    observeSlideChildren?: boolean;
    oneWayMovement?: boolean;
    passiveListeners?: boolean;
    preventClicks?: boolean;
    preventClicksPropagation?: boolean;
    preventInteractionOnTransition?: boolean;
    resistance?: boolean;
    resistanceRatio?: number;
    resizeObserver?: boolean;
    rewind?: boolean;
    roundLengths?: boolean;
    runCallbacksOnInit?: boolean;
    setWrapperSize?: boolean;
    shortSwipes?: boolean;
    simulateTouch?: boolean;
    slideActiveClass?: string;
    slideBlankClass?: string;
    slideClass?: string;
    slideFullyVisibleClass?: string;
    slideNextClass?: string;
    slidePrevClass?: string;
    slidesOffsetAfter?: number;
    slidesOffsetBefore?: number;
    slidesPerGroup?: number;
    slidesPerGroupAuto?: boolean;
    slidesPerGroupSkip?: number;
    slidesPerView?: number | "auto";
    slideToClickedSlide?: boolean;
    slideVisibleClass?: string;
    snapToSlideEdge?: boolean;
    spaceBetween?: string | number;
    speed?: number;
    swipeHandler?: CSSSelector | HTMLElement | null;
    swiperElementNodeName?: string;
    threshold?: number;
    touchAngle?: number;
    touchEventsTarget?: "container" | "wrapper";
    touchMoveStopPropagation?: boolean;
    touchRatio?: number;
    touchReleaseOnEdges?: boolean;
    touchStartForcePreventDefault?: boolean;
    touchStartPreventDefault?: boolean;
    uniqueNavElements?: boolean;
    updateOnWindowResize?: boolean;
    url?: string | null;
    userAgent?: string | null;
    virtualTranslate?: boolean;
    watchOverflow?: boolean;
    watchSlidesProgress?: boolean;
    width?: number | null;
    wrapperClass?: string;
}

Hierarchy (View Summary)

SwiperOptions
- SwiperOptions

Index

Properties

_emitClasses? _loopSwapReset? allowSlideNext? allowSlidePrev? allowTouchMove? autoHeight? breakpoints? breakpointsBase? centeredSlides? centeredSlidesBounds? centerInsufficientSlides? containerModifierClass? createElements? cssMode? direction? edgeSwipeDetection? edgeSwipeThreshold? effect? enabled? eventsPrefix? focusableElements? followFinger? grabCursor? height? init? initialSlide? injectStyles? injectStylesUrls? lazyPreloaderClass? lazyPreloadPrevNext? longSwipes? longSwipesMs? longSwipesRatio? loop? loopAddBlankSlides? loopAdditionalSlides? loopPreventsSliding? maxBackfaceHiddenSlides? modules? nested? normalizeSlideIndex? noSwiping? noSwipingClass? noSwipingSelector? observeParents? observer? observeSlideChildren? oneWayMovement? passiveListeners? preventClicks? preventClicksPropagation? preventInteractionOnTransition? resistance? resistanceRatio? resizeObserver? rewind? roundLengths? runCallbacksOnInit? setWrapperSize? shortSwipes? simulateTouch? slideActiveClass? slideBlankClass? slideClass? slideFullyVisibleClass? slideNextClass? slidePrevClass? slidesOffsetAfter? slidesOffsetBefore? slidesPerGroup? slidesPerGroupAuto? slidesPerGroupSkip? slidesPerView? slideToClickedSlide? slideVisibleClass? snapToSlideEdge? spaceBetween? speed? swipeHandler? swiperElementNodeName? threshold? touchAngle? touchEventsTarget? touchMoveStopPropagation? touchRatio? touchReleaseOnEdges? touchStartForcePreventDefault? touchStartPreventDefault? uniqueNavElements? updateOnWindowResize? url? userAgent? virtualTranslate? watchOverflow? watchSlidesProgress? width? wrapperClass?

Properties

`Optional`_emitClasses

_emitClasses?: boolean

!INTERNAL When enabled will emit "_containerClasses" and "_slideClass" events

`Optional`_loopSwapReset

_loopSwapReset?: boolean

!INTERNAL Set by effect-cards.overwriteParams to opt the cards effect out of the loop-swap reset that runs on the touch-move boundary.

`Optional`allowSlideNext

allowSlideNext?: boolean

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

Default

true

`Optional`allowSlidePrev

allowSlidePrev?: boolean

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

Default

true

`Optional`allowTouchMove

allowTouchMove?: boolean

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

Default

true

`Optional`autoHeight

autoHeight?: boolean

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

Default

false

`Optional`breakpoints

breakpoints?: { [width: number]: SwiperOptions; [ratio: string]: SwiperOptions }

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

Example

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

Example

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

`Optional`breakpointsBase

breakpointsBase?: "container" | CSSSelector | "window"

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

Default

'window'

`Optional`centeredSlides

centeredSlides?: boolean

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

Default

false

`Optional`centeredSlidesBounds

centeredSlidesBounds?: boolean

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

Default

false

`Optional`centerInsufficientSlides

centerInsufficientSlides?: boolean

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

Default

false

`Optional`containerModifierClass

containerModifierClass?: string

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

Default

'swiper-'

`Optional`createElements

createElements?: boolean

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

Default

false

`Optional`cssMode

cssMode?: boolean

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 class="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.

Example

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

Default

false

`Optional`direction

direction?: "horizontal" | "vertical"

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

Default

'horizontal'

`Optional`edgeSwipeDetection

edgeSwipeDetection?: string | boolean

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.

Default

false

`Optional`edgeSwipeThreshold

edgeSwipeThreshold?: number

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

Default

`Optional`effect

effect?:
    | "slide"
    | "fade"
    | "cube"
    | "coverflow"
    | "flip"
    | "creative"
    | "cards"
    | string & {}

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

Default

'slide'

`Optional`enabled

enabled?: boolean

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

Default

true

`Optional`eventsPrefix

eventsPrefix?: string

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

Default

swiper

`Optional`focusableElements

focusableElements?: string

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

Default

'input, select, option, textarea, button, video, label'

`Optional`followFinger

followFinger?: boolean

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

Default

true

`Optional`grabCursor

grabCursor?: boolean

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

Default

false

`Optional`height

height?: number | null

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

Default

null

Note

Setting this parameter will make Swiper not responsive

`Optional`init

init?: boolean

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

Default

true

`Optional`initialSlide

initialSlide?: number

Index number of initial slide.

Default

`Optional`injectStyles

injectStyles?: string[]

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

`Optional`injectStylesUrls

injectStylesUrls?: string[]

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

`Optional`lazyPreloaderClass

lazyPreloaderClass?: string

CSS class name of lazy preloader

Default

'swiper-lazy-preloader'

`Optional`lazyPreloadPrevNext

lazyPreloadPrevNext?: number

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

Default

`Optional`longSwipes

longSwipes?: boolean

Set to false if you want to disable long swipes

Default

true

`Optional`longSwipesMs

longSwipesMs?: number

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

Default

`Optional`longSwipesRatio

longSwipesRatio?: number

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

Default

0.5

`Optional`loop

loop?: boolean

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 (and + 1 in case of centeredSlides)
even to slidesPerGroup (or use loopAddBlankSlides parameter)
even to grid.rows (or use loopAddBlankSlides parameter)

Default

false

`Optional`loopAddBlankSlides

loopAddBlankSlides?: boolean

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

Default

true

`Optional`loopAdditionalSlides

loopAdditionalSlides?: number

Allows to increase amount of looped slides

Default

`Optional`loopPreventsSliding

loopPreventsSliding?: boolean

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

Default

true

`Optional`maxBackfaceHiddenSlides

maxBackfaceHiddenSlides?: number

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.

Note

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

Default

`Optional`modules

modules?: SwiperModule[]

Array with Swiper modules

Example

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

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

`Optional`nested

nested?: boolean

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

Default

false

`Optional`normalizeSlideIndex

normalizeSlideIndex?: boolean

Normalize slide index.

Default

true

`Optional`noSwiping

noSwiping?: boolean

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

Default

true

`Optional`noSwipingClass

noSwipingClass?: string

Specify noSwiping's element css class

Default

'swiper-no-swiping'

`Optional`noSwipingSelector

noSwipingSelector?: string

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

Default

`Optional`observeParents

observeParents?: boolean

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

Default

false

`Optional`observer

observer?: boolean

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)

Default

false

`Optional`observeSlideChildren

observeSlideChildren?: boolean

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

Default

false

`Optional`oneWayMovement

oneWayMovement?: boolean

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

Default

false

`Optional`passiveListeners

passiveListeners?: boolean

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

Default

true

`Optional`preventClicks

preventClicks?: boolean

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

Default

true

`Optional`preventClicksPropagation

preventClicksPropagation?: boolean

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

Default

true

`Optional`preventInteractionOnTransition

preventInteractionOnTransition?: boolean

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

Default

false

`Optional`resistance

resistance?: boolean

Set to false if you want to disable resistant bounds

Default

true

`Optional`resistanceRatio

resistanceRatio?: number

This option allows you to control resistance ratio

Default

0.85

`Optional`resizeObserver

resizeObserver?: boolean

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

Default

true

`Optional`rewind

rewind?: boolean

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.

Default

false

Note

Should not be used together with loop mode

`Optional`roundLengths

roundLengths?: boolean

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

Default

false

`Optional`runCallbacksOnInit

runCallbacksOnInit?: boolean

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

Default

true

`Optional`setWrapperSize

setWrapperSize?: boolean

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

Default

false

`Optional`shortSwipes

shortSwipes?: boolean

Set to false if you want to disable short swipes

Default

true

`Optional`simulateTouch

simulateTouch?: boolean

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

Default

true

`Optional`slideActiveClass

slideActiveClass?: string

CSS class name of currently active slide

Default

'swiper-slide-active'

Note

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

Note

Not supported in Swiper React/Vue components

`Optional`slideBlankClass

slideBlankClass?: string

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

Default

'swiper-slide-blank'

Note

Not supported in Swiper React/Vue

`Optional`slideClass

slideClass?: string

CSS class name of slide

Default

'swiper-slide'

Note

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

Note

Not supported in Swiper React/Vue components

`Optional`slideFullyVisibleClass

slideFullyVisibleClass?: string

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

Default

'swiper-slide-fully-visible'

Note

Not supported in Swiper React/Vue

`Optional`slideNextClass

slideNextClass?: string

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

Default

'swiper-slide-next'

Note

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

Note

Not supported in Swiper React/Vue

`Optional`slidePrevClass

slidePrevClass?: string

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

Default

'swiper-slide-prev'

Note

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

Note

Not supported in Swiper React/Vue

`Optional`slidesOffsetAfter

slidesOffsetAfter?: number

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

Default

`Optional`slidesOffsetBefore

slidesOffsetBefore?: number

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

Default

`Optional`slidesPerGroup

slidesPerGroup?: number

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

Default

`Optional`slidesPerGroupAuto

slidesPerGroupAuto?: boolean

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.

Default

false

`Optional`slidesPerGroupSkip

slidesPerGroupSkip?: number

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.

Default

`Optional`slidesPerView

slidesPerView?: number | "auto"

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

Note

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

Default

`Optional`slideToClickedSlide

slideToClickedSlide?: boolean

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

Default

false

`Optional`slideVisibleClass

slideVisibleClass?: string

CSS class name of currently/partially visible slide

Default

'swiper-slide-visible'

Note

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

Note

Not supported in Swiper React/Vue

`Optional`snapToSlideEdge

snapToSlideEdge?: boolean

When enabled, the swiper will always snap to slide edges rather than arbitrary positions. This prevents partial slides from appearing misaligned at the end of the swiper. Only applies when slidesPerView is fractional or 'auto', and is ignored in loop and centeredSlides modes.

Default

false

`Optional`spaceBetween

spaceBetween?: string | number

Distance between slides in px.

Default

Note

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

`Optional`speed

speed?: number

Duration of transition between slides (in ms)

Default

`Optional`swipeHandler

swipeHandler?: CSSSelector | HTMLElement | null

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

Default

null

`Optional`swiperElementNodeName

swiperElementNodeName?: string

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

Default

'SWIPER-CONTAINER'

`Optional`threshold

threshold?: number

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

Default

`Optional`touchAngle

touchAngle?: number

Allowable angle (in degrees) to trigger touch move

Default

`Optional`touchEventsTarget

touchEventsTarget?: "container" | "wrapper"

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)

Default

'wrapper'

`Optional`touchMoveStopPropagation

touchMoveStopPropagation?: boolean

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

Default

false

`Optional`touchRatio

touchRatio?: number

Touch ratio

Default

`Optional`touchReleaseOnEdges

touchReleaseOnEdges?: boolean

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

Default

false

`Optional`touchStartForcePreventDefault

touchStartForcePreventDefault?: boolean

Force to always prevent default for touchstart (pointerdown) event

Default

false

`Optional`touchStartPreventDefault

touchStartPreventDefault?: boolean

If disabled, pointerdown event won't be prevented

Default

true

`Optional`uniqueNavElements

uniqueNavElements?: boolean

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

Default

true

`Optional`updateOnWindowResize

updateOnWindowResize?: boolean

Swiper will recalculate slides position on window resize (orientationchange)

Default

true

`Optional`url

url?: string | null

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

Default

null

`Optional`userAgent

userAgent?: string | null

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

Default

null

`Optional`virtualTranslate

virtualTranslate?: boolean

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

Default

false

`Optional`watchOverflow

watchOverflow?: boolean

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

Default

true

`Optional`watchSlidesProgress

watchSlidesProgress?: boolean

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

Default

false

`Optional`width

width?: number | null

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

Default

null

Note

Setting this parameter will make Swiper not responsive

`Optional`wrapperClass

wrapperClass?: string

CSS class name of slides' wrapper

Default

'swiper-wrapper'

Note

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

Note

Not supported in Swiper React/Vue

Interface SwiperOptions

Hierarchy (View Summary)

Index

Properties

Properties

Optional_emitClasses

Optional_loopSwapReset

OptionalallowSlideNext

Default

OptionalallowSlidePrev

Default

OptionalallowTouchMove

Default

OptionalautoHeight

Default

Optionalbreakpoints

Example

Example

OptionalbreakpointsBase

Default

OptionalcenteredSlides

Default

OptionalcenteredSlidesBounds

Default

OptionalcenterInsufficientSlides

Default

OptionalcontainerModifierClass

Default

OptionalcreateElements

Default

OptionalcssMode

Example

Default

Optionaldirection

Default

OptionaledgeSwipeDetection

Default

OptionaledgeSwipeThreshold

Default

Optionaleffect

Default

Optionalenabled

Default

OptionaleventsPrefix

Default

OptionalfocusableElements

Default

OptionalfollowFinger

Default

OptionalgrabCursor

Default

Optionalheight

Default

Note

Optionalinit

Default

OptionalinitialSlide

Default

OptionalinjectStyles

OptionalinjectStylesUrls

OptionallazyPreloaderClass

Default

OptionallazyPreloadPrevNext

Default

OptionallongSwipes

Default

OptionallongSwipesMs

Default

OptionallongSwipesRatio

Default

Optionalloop

Default

OptionalloopAddBlankSlides

Default

OptionalloopAdditionalSlides

Default

OptionalloopPreventsSliding

Default

OptionalmaxBackfaceHiddenSlides

Note

`Optional`_emitClasses

`Optional`_loopSwapReset

`Optional`allowSlideNext

`Optional`allowSlidePrev

`Optional`allowTouchMove

`Optional`autoHeight

`Optional`breakpoints

`Optional`breakpointsBase

`Optional`centeredSlides

`Optional`centeredSlidesBounds

`Optional`centerInsufficientSlides

`Optional`containerModifierClass

`Optional`createElements

`Optional`cssMode

`Optional`direction

`Optional`edgeSwipeDetection

`Optional`edgeSwipeThreshold

`Optional`effect

`Optional`enabled

`Optional`eventsPrefix

`Optional`focusableElements

`Optional`followFinger

`Optional`grabCursor

`Optional`height

`Optional`init

`Optional`initialSlide

`Optional`injectStyles

`Optional`injectStylesUrls

`Optional`lazyPreloaderClass

`Optional`lazyPreloadPrevNext

`Optional`longSwipes

`Optional`longSwipesMs

`Optional`longSwipesRatio

`Optional`loop

`Optional`loopAddBlankSlides

`Optional`loopAdditionalSlides

`Optional`loopPreventsSliding

`Optional`maxBackfaceHiddenSlides

`Optional`modules

`Optional`nested

`Optional`normalizeSlideIndex

`Optional`noSwiping

`Optional`noSwipingClass

`Optional`noSwipingSelector

`Optional`observeParents

`Optional`observer

`Optional`observeSlideChildren

`Optional`oneWayMovement

`Optional`passiveListeners

`Optional`preventClicks

`Optional`preventClicksPropagation

`Optional`preventInteractionOnTransition

`Optional`resistance

`Optional`resistanceRatio

`Optional`resizeObserver

`Optional`rewind

`Optional`roundLengths

`Optional`runCallbacksOnInit

`Optional`setWrapperSize

`Optional`shortSwipes

`Optional`simulateTouch

`Optional`slideActiveClass

`Optional`slideBlankClass

`Optional`slideClass

`Optional`slideFullyVisibleClass

`Optional`slideNextClass

`Optional`slidePrevClass