Watchoverflow swiper не работает

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

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

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

Methods & Properties

After we initialize Slider we have its initialized instance in variable (like swiper variable in example above) with helpful methods and properties:

Dom7 element with slider container HTML element. To get vanilla HTMLElement use swiper.el

Dom7 element with slider wrapper HTML element. To get vanilla HTMLElement use swiper.wrapperEl

Index number of currently active slide

Note, that in loop mode active index value will be always shifted on a number of looped/duplicated slides

Disable / enable ability to slide to the next slides by assigning false / true to this property

Disable / enable ability to slide to the previous slides by assigning false / true to this property

Disable / enable ability move slider by grabbing it with mouse or by touching it with finger (on touch screens) by assigning false / true to this property

true if swiper is in transition

Index number of last clicked slide

Link to last clicked slide (HTMLElement)

Slider container HTML element

Height of container

true if slider on most «left»/»top» position

true if slider on most «right»/»bottom» position

Object with original initialization parameters

Object with passed initialization parameters

Index number of previously active slide

Current progress of wrapper translate (from 0 to 1)

Index number of currently active slide considering duplicated slides in loop mode

Dom7 array-like collection of slides HTML elements. To get specific slide HTMLElement use swiper.slides[1]

Object with the following touch event properties:

• swiper.touches.startX
• swiper.touches.startY
• swiper.touches.currentX
• swiper.touches.currentY
• swiper.touches.diff

Current value of wrapper translate

Width of container

Wrapper HTML element

Swiper default options

Object with global Swiper extended options

Attach all events listeners again

Changes slider direction from horizontal to vertical and back.

• direction — ‘horizontal’ | ‘vertical’ — New direction. If not specified, then will automatically changed to opposite direction
• needUpdate — boolean — Will call swiper.update(). Default true

Destroy slider instance and detach all events listeners

• deleteInstance — boolean — Set it to false (by default it is true) to not to delete Swiper instance
• cleanStyles — boolean — Set it to true (by default it is true) and all custom styles will be removed from slides, wrapper and container. Useful if you need to destroy Swiper and to init again with new options or in different direction

Detach all events listeners

Disable Swiper (if it was enabled). When Swiper is disabled, it will hide all navigation elements and won’t respond to any events and interactions

Fire event on instance

Enable Swiper (if it was disabled)

Get current value of swiper wrapper css3 transform translate

Remove event handler

Remove event listener that will be fired on all events

Add event handler

Add event listener that will be fired on all events

Add event handler that will be removed after it was fired

Set grab cursor

Set Swiper translate progress (from 0 to 1). Where 0 — its initial position (offset) on first slide, and 1 — its maximum position (offset) on last slide

• progress — number — Swiper translate progress (from 0 to 1).
• speed — number — Transition duration (in ms).

Set custom css3 transform’s translate value for swiper wrapper

Run transition to next slide.

• speed — number — Transition duration (in ms).
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events.

Run transition to previous slide.

• speed — number — Transition duration (in ms).
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events.

Reset swiper position to currently active slide for the duration equal to ‘speed’ parameter.

• speed — number — Transition duration (in ms).
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events.

Run transition to the slide with index number equal to ‘index’ parameter for the duration equal to ‘speed’ parameter.

• index — number — Index number of slide.
• speed — number — Transition duration (in ms).
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events.

Reset swiper position to closest slide/snap point for the duration equal to ‘speed’ parameter.

• speed — number — Transition duration (in ms).
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events.

Does the same as .slideTo but for the case when used with enabled loop. So this method will slide to slides with realIndex matching to passed index

• index — number — Index number of slide.
• speed — number — Transition duration (in ms).
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events.

Animate custom css3 transform’s translate value for swiper wrapper

• translate — number — Translate value (in px)
• speed — number — Transition duration (in ms)
• runCallbacks — boolean — Set it to false (by default it is true) and transition will not produce transition events
• translateBounds — boolean — Set it to false (by default it is true) and transition value can extend beyond min and max translate

Unset grab cursor

You should call it after you add/remove slides manually, or after you hide/show it, or do any custom DOM modifications with Swiper This method also includes subcall of the following methods which you can use separately:

Force swiper to update its height (when autoHeight enabled) for the duration equal to ‘speed’ parameter

• speed — number — Transition duration (in ms).

recalculate swiper progress

recalculate size of swiper container

recalculate number of slides and their offsets. Useful after you add/remove slides with JavaScript

update active/prev/next classes on slides and bullets

Extend global Swiper defaults

Installs modules on Swiper in runtime.

Events

Swiper comes with a bunch of useful events you can listen. Events can be assigned in two ways:

Using on parameter on swiper initialization:

Using on method after swiper initialization.

Event will fired on active index change

Event will fired right after initialization

Event will be fired right before Swiper destroyed

Event will fired right before initialization

Event will be fired right before «loop fix»

Event will fired before resize handler

Event will fired before slide change transition start

Event will fired before transition start

Event will be fired on breakpoint change

Event will fired on direction change

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

Event will be fired on swiper destroy

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

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

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

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

Fired right after Swiper initialization.

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

Event will be fired after «loop fix»

Event will be fired on momentum bounce

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

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

Event will be fired when Swiper progress is changed, as an arguments it receives progress that is always from 0 to 1

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

Event will be fired when Swiper reach last slide

Event will fired on real index change

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

Event will be fired everytime when swiper starts animation. Receives current transition duration (in ms) as an arguments

Event will be fired when swiper’s wrapper change its position. Receives current translate value as an arguments

Event will be fired when currently active slide is changed

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

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

Same as «slideChangeTransitionEnd» but for «forward» direction only

Same as «slideChangeTransitionStart» but for «forward» direction only

Same as «slideChangeTransitionEnd» but for «backward» direction only

Same as «slideChangeTransitionStart» but for «backward» direction only

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

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

Event will be fired with first touch/drag move

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

Event will be fired when slides grid has changed

Event will be fired when number of slides has changed

Event will be fired when snap grid has changed

Event will fired on snap index change

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

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

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

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

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

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

Event will be fired after transition.

Event will be fired in the beginning of transition.

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

Event will be fired after swiper.update() call

Modules

Navigation

Navigation Parameters

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

CSS class name added to navigation button when it becomes disabled

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

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

Navigation Methods

HTMLElement of «next» navigation button

HTMLElement of «previous» navigation button

Update navigation buttons state (enabled/disabled)

Navigation Events

Event will be fired on navigation hide

Event will be fired on navigation show

Pagination

Pagination Parameters

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

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

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

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

Pagination Methods

Dom7 array-like collection of pagination bullets HTML elements. To get specific slide HTMLElement use swiper.pagination.bullets[1] .

HTMLElement of pagination container element

Render pagination layout

Update pagination state (enabled/disabled/active)

Pagination Events

Event will be fired on pagination hide

Event will be fired after pagination rendered

Event will be fired on pagination show

Event will be fired when pagination updated

Scrollbar

Scrollbar Parameters

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

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.

Hide scrollbar automatically after user interaction

Scrollbar element additional CSS class when it is disabled

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

Scrollbar Methods

HTMLElement of Scrollbar draggable handler element

HTMLElement of Scrollbar container element

Updates scrollbar translate

Updates scrollbar track and handler sizes

Scrollbar Events

Event will be fired on draggable scrollbar drag end

Event will be fired on draggable scrollbar drag move

Event will be fired on draggable scrollbar drag start

Autoplay

Autoplay Parameters

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

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 using data-swiper-autoplay (in ms) attribute on slide.

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 mouse enter over Swiper container. If disableOnInteraction is also enabled, it will stop autoplay instead of pause

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

Autoplay Methods

Whether autoplay enabled and running

Autoplay Events

Event will be fired when slide changed with autoplay

Event will be fired in when autoplay started

Event will be fired when autoplay stopped

Free Mode

Free Mode Parameters

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

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

Grid Parameters

Object with grid parameters to enable «multirow» slider.

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

Number of slides rows, for multirow layout

rows > 1 is currently not compatible with loop mode ( loop: true )

Manipulation

Manipulation module adds useful Swiper methods to manipulate slides. It makes sense to use it only with Swiper Core version, not intended to be uses with Swiper Angular, React, Svelte or Vue.

Manipulation Methods

Add new slides to the required index. slides could be HTMLElement or HTML string with new slide or array with such slides, for example:

Add new slides to the end. slides could be HTMLElement or HTML string with new slide or array with such slides, for example:

Add new slides to the beginning. slides could be HTMLElement or HTML string with new slide or array with such slides, for example:

Remove all slides

Remove selected slides. slideIndex could be a number with slide index to remove or array with indexes.

Parallax

Swiper supports parallax transition effects for swiper/slides nested elements. There are two types of parallax elements supported:

• Direct child elements of swiper . Parallax effect for such elements will depend on total slider progress. Useful for parallax backgrounds
• Slides child elements. Parallax effect for such elements will depend on slide progress

To enable parallax effects you need to init Swiper with passed parallax:true parameter and add one of the following (or mix) attributes to required elements:

• data-swiper-parallax — enable transform-translate parallax transition. This attribute may accept:
  • number — value in px (as for title, subtitle in example above) to move element depending on progress. In this case such element will be moved on ± this value in px depending on slide position (next or previous)
  • percentage — (as for «parallax-bg») to move element depending on progress and on its size. In this case such element will be moved on ± this percentage of its size (width in horizontal direction, and height in vertical direction) depending on slide position (next or previous). So if element has 400px width and you specified data-swiper-parallax=»50%» then it will be moved on ± 200px
• data-swiper-parallax-x — same but for x-axis direction
• data-swiper-parallax-y — same but for y-axis direction
• data-swiper-parallax-scale — scale ratio of the parallax element when it is in «inactive» (not on active slide) state
• data-swiper-parallax-opacity — opacity of the parallax element when it is in «inactive» (not on active slide) state
• data-swiper-parallax-duration — custom transition duration for parallax elements

Parallax Parameters

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

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

Lazy Loading

To enable lazy loading, first of all we need a special layout for images or elements with background in slides:

• Each lazy loaded image/element should have additional «swiper-lazy» class
• Lazy image source for element should be specified in «data-src» attribute instead of «src»
• Lazy image source set for element should be specified in «data-srcset» attribute instead of «srcset»
• Lazy background image source should be specified in «data-background» attribute

You may also add animated preloader spinner to slide which will be removed automatically after image loaded:

Or white one for dark layout:

After that we need to enable lazy loading on Swiper initialization:

Lazy Loading Parameters

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

Enables to check is the Swiper in view before lazy loading images on initial slides

CSS class name of lazy element

By default, Swiper will load lazy images after transition to this slide, so you may enable this parameter if you need it to start loading of new image in the beginning of transition

Set to true to enable lazy loading for the closest slides images (for previous and next slide images)

Amount of next/prev slides to preload lazy images in. Can’t be less than slidesPerView

CSS class name of lazy loaded element

CSS class name of lazy loading element

CSS class name of lazy preloader

Element to check scrolling on for checkInView . Defaults to window

Lazy Loading Methods

Load/update lazy images based on current slider state (position)

Force to load lazy images in slide by specified index

Lazy Loading Events

Event will be fired in the beginning of lazy loading of image

Event will be fired when lazy loading image will be loaded

Fade Effect

Be sure to have the effect param set to ‘fade’ in order for this to work.

Fade Effect Parameters

Object with Fade-effect parameters

Enables slides cross fade

CSS selector of the element inside of the slide to transform instead of the slide itself. Useful to use with cssMode

Coverflow Effect

Be sure to have the effect param set to ‘coverflow’ in order for this to work.

Coverflow Effect Parameters

Object with Coverflow-effect parameters.

Depth offset in px (slides translate in Z axis)

Slide rotate in degrees

Enables slides shadows

Stretch space between slides (in px)

CSS selector of the element inside of the slide to transform instead of the slide itself. Useful to use with cssMode

Flip Effect

Be sure to have the effect param set to ‘flip’ in order for this to work.

Flip Effect Parameters

Object with Flip-effect parameters

Limit edge slides rotation

Enables slides shadows

CSS selector of the element inside of the slide to transform instead of the slide itself. Useful to use with cssMode

Cube Effect

Be sure to have the effect param set to ‘cube’ in order for this to work.

Cube Effect Parameters

Object with Cube-effect parameters

Enables main slider shadow

Main shadow offset in px

Main shadow scale ratio

Enables slides shadows

Cards Effect

Be sure to have the effect param set to ‘cards’ in order for this to work.

Cards Effect Parameters

Object with Cards-effect parameters

Enables slides shadows

CSS selector of the element inside of the slide to transform instead of the slide itself. Useful to use with cssMode

Creative Effect

Be sure to have the effect param set to ‘creative’ in order for this to work.

Creative Effect Parameters

Object with Creative-effect parameters

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.

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

Previous slide transformations. Accepts object of the following type:

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

CSS selector of the element inside of the slide to transform instead of the slide itself. Useful to use with cssMode

Thumbs

In addition to Controller component Swiper comes with Thumbs component that is designed to work with additional thumbs swiper in a more correct way than Controller which is used for syncing two swipers.

Thumbs Parameters

Object with thumbs component parameters

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

Thumbs Methods

Swiper instance of thumbs swiper

Swiper supports zoom images functionality (similar to what you see on iOS when browsing single photo) where you can zoom-in image by pinch gesture and or by zoom-in/out by double tap on it. In this case, additional layout is required:

All «zoomable» images should be wrapped with the div with swiper-zoom-container class.

By default it expects to zoom one of the img , picture or canvas element. If you want to make zoom on some other custom element, then just add swiper-zoom-target class to this element. For example:

You can override maxRatio parameter for specific slides by using data-swiper-zoom attribute on zoom container.

Zoom Parameters

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

CSS class name of zoom container

Maximum image zoom multiplier

Minimal image zoom multiplier

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

CSS class name of zoomed in container

Zoom Methods

Whether the zoom module is enabled

Current image scale ratio

Disable zoom module

Enable zoom module

Zoom in image of the currently active slide

Zoom out image of the currently active slide

Toggle image zoom of the currently active slide

Zoom Events

Event will be fired on zoom change

Keyboard Control

Keyboard Control Parameters

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

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

Keyboard Control Methods

Whether the keyboard control is enabled

Disable keyboard control

Enable keyboard control

Keyboard Events

Event will be fired on key press

Mousewheel Control

Mousewheel Control Parameters

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

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

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

Mousewheel Control Methods

Whether the mousewheel control is enabled

Disable mousewheel control

Enable mousewheel control

Mousewheel Events

Event will be fired on mousewheel scroll

Virtual Slides

Virtual Slides module allows to keep just required amount of slides in DOM. It is very useful in terms in performance and memory issues if you have a lot of slides, especially slides with heavyweight DOM tree or images.

Virtual Slides Parameters

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

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.

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

Array with slides

Virtual Slides Methods

Object with cached slides HTML elements

Index of first rendered slide

Array with slide items passed by virtual.slides parameter

Index of last rendered slide

Append slide. slides can be a single slide item or array with such slides.

Prepend slide. slides can be a single slide item or array with such slides.

Remove all slides

Remove specific slide or slides. slideIndexes can be a number with slide index to remove or array with indexes.

Update virtual slides state

Hash Navigation

Hash navigation is intended to have a link to specific slide that allows to load page with specific slide opened.

To make it work, you need to enable it by passing hashNavigation:true parameter and adding slides hashes in data-hash attribute:

Hash Navigation Parameters

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

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

Hash Navigation Events

Event will be fired on window hash change

Event will be fired when swiper updates the hash

History Navigation

History Navigation Parameters

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

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/

Controller

Controller Parameters

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

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

Set to true and controlling will be in inverse direction

Controller Methods

Pass here another Swiper instance or array with Swiper instances that should be controlled by this Swiper

Accessibility (a11y)

Accessibility Parameters

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

Message for screen readers for outer swiper container

Message for screen readers describing the role of outer swiper container

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

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

Message for screen readers describing the label of slide element

Value of swiper slide role attribute

Custom Build

You have two options of making custom version of Swiper.

Using JS Modules

If you use bundler with JS modules support in your project you can import only the modules you need:

The following modules are exported:

• Virtual — Virtual Slides module
• Keyboard — Keyboard Control module
• Mousewheel — Mousewheel Control module
• Navigation — Navigation module
• Pagination — Pagination module
• Scrollbar — Scrollbar module
• Parallax — Parallax module
• FreeMode — Free Mode module
• Grid — Grid module
• Manipulation — Slides manipulation module (only for Core version)
• Zoom — Zoom module
• Lazy — Lazy module
• Controller — Controller module
• A11y — Accessibility module
• History — History Navigation module
• HashNavigation — Hash Navigation module
• Autoplay — Autoplay module
• EffectFade — Fade Effect module
• EffectCube — Cube Effect module
• EffectFlip — Flip Effect module
• EffectCoverflow — Coverflow Effect module
• EffectCards — Cards Effect module
• EffectCreative — Creative Effect module
• Thumbs — Thumbs module

Using Build Script

Swiper comes with gulp builder that allows to build custom library version where you may include only required modules. We need the following:

Download and unzip Swiper GitHub repository to local folder

Install Node.js (if not installed)

Now, we need to install required dependencies. Go to the folder with downloaded and unzipped Swiper repository and execute in terminal:

Open scripts/build-config.js file:

Now, we are ready to build custom version of Swiper:

That is all. Generated CSS and JS files and their minified versions will be available in dist/ folder.

TypeScript Definitions

Swiper is fully typed, it exports Swiper and SwiperOptions types:

You can also check auto generated TypeScript definitions explorer for all the types, options, properties and methods.

Источник