Super fast lightweight carousel and slider with touch for optimized websites running in modern browsers.
Explore Swiffy Slider docs »
See examples
·
Visual carousel and slider configuration
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
swiffy-slider |
The overall wrapper of the slider instance. Should be a block element. Can contain 3 different things as direct children; slider-container, slider-indicators and slider-nav |
swiffy-slider wrapper. These sections adds slides, navigation and indicators
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
slider-container |
|
slider-navslider-nav-next |
|
slider-indicators |
|
swiffy-slider wrapper. The slider-item-* option classes affects the slides (The slider-container children)
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
slider-item-show2slider-item-show3slider-item-show4slider-item-show5slider-item-show6 |
Shows 2, 3, 4, 5 or 6 slides at a time in the slider wrapper. Each slide is either 1/2, 1/3, 1/4, 1/5 or 1/6 of the slider wrapper width. |
slider-item-show2-sm |
Shows 2 slides at a time in the slider wrapper when in small viewport. By default show2-5 will show only one slide when in viewports less than 62rem (992px in most cases). With this option it shows 2 in small viewports |
slider-item-reveal |
Reveals some of previous and next slide. Each slide is either 1/1, 1/2, 1/3, 1/4 or 1/6 of the slider wrapper width minus a little to reveal next and previous slides |
slider-item-ratio |
Enables ratio sizing of the slide elements. Default ratio is 2:1 or 50% meaning the slides have half the heigh of their width.
This option sets object-fit:cover; on first element inside the slide element - to stretch images to fill out the slide box and keep aspect ratio. |
slider-item-ratio-32x9slider-item-ratio-21x9slider-item-ratio-2x1slider-item-ratio-16x9slider-item-ratio-4x3slider-item-ratio-1x1slider-item-ratio-3x4 |
Controls the slide ratio when ratio is enabled. Default ratio is 2:1 or 50% meaning the slides have half the heigh of their widt. |
slider-item-ratio-contain |
Sets the content of a ratio enabled slide to have object-fit:contain; instead of default object-fit:cover;. This ensures that if the content of the slide is an image or embedded video, it is scaled down so all is visible within the slide box. |
slider-item-nogap |
Removes the horisontal gap between slides |
slider-item-snapstart |
Snaps slides to start of the slider wrapper instead of center when using .slider-item-reveal |
slider-item-nosnap |
Removes auto snapping for slides so they slide freely. Primarily have an affect on touch devices as navigating with arrows and indicators is per slide or per page |
slider-item-nosnap-touch |
Same effect as slider-item-nosnap but only on devices that has a primary input which is not a mouse, i.e. mobile media (hover: none) |
slider-item-first-visible |
Use with .slider-nav-autohide to hide the previous navigation arrow when the slider loads. Will automatically be removed or added when first slide is not or is visible |
slider-item-last-visible |
Use with .slider-nav-autohide to hide the next navigation arrow when the slider loads. Will automatically be removed or added when last slide is not or is visible |
slider-item-helper |
For debugging: Adds a test layout to slide items; minimum height, background color, centers content and background. Meant for testing and should be removed in real code |
swiffy-slider wrapper. The slider-nav-* option classes affects the slider-nav elements
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
slider-nav-page |
Slides entire page when showing more than one slide item on the slider wrapper. Default behavior moves just one slide to the left or right |
slider-nav-noloop |
Disables slider loop - so when on first/last slide navigate previous/next does not take the user to the last/first slide |
slider-nav-nodelay |
Disables smooth scrolling when sliding using navigation buttons, indicators and autoplay. Makes the new slide or page appear instantly with no scroll smoothing. Does not affect touch navigation |
slider-nav-autoplay |
Automatically slide to next slide or next page in intervals. Default is 2500 ms = 2.5s |
data-slider-nav-autoplay-interval attribute |
Changes the default autoplay interval - value is in ms. data-slider-nav-autoplay-interval="3000". Default value is 2500, minimum value is 750 ms |
slider-nav-autopause |
Stops and restarts the autoplay when mouse is hovering the slider wrapper or when it is touched on touch devices. Will restart on mouseout, but not when touch ends |
slider-nav-round |
Changes the default navigation arrows to a circle with arrow. Default color is white with black arrow |
slider-nav-touch |
Shows navigation buttons on touch devices. By default navigation buttons are hidden on touch devices using the media (hover: none) query. By adding this option, the navigation buttons are always visible on touch devices |
slider-nav-visible |
Makes the nav buttons visible always. By default navigation buttons are hidden until the slider wrapper is hovered |
slider-nav-outside |
Moves the navigation buttons outside the slider wrapper and shrinks the width of the slider wrapper accordingly (by 3 or 5 rem on each side depending on navigation style) |
slider-nav-outside-expand |
Moves the navigation buttons outside the slider wrapper by applying negative margins (-3 or -5 rem) so the slides and wrapper keeps their size. The navigation buttons overlays surrounding content. |
slider-nav-scrollbar |
Makes the scrollbar for the .slider-container visible. Acts as indicator and navigation if running in css only mode. On touch devices the scrollbar is not shown when not sliding because that is how the browser behaves |
slider-nav-dark |
Changes the navigation buttons to a dark version. Black arrows or black circle with white arrows |
slider-nav-autohide |
Will hide appropiate navigation arrow when the first or last slide is visible to indicate that sliding is at its start or end. On load the arrow will first disappear when the script is loaded. Also add `.slider-item-first-visible` class to the `.swiffy-slider` instance together with `.slider-nav-autohide` to hide the start arrow on load before js executes. |
swiffy-slider wrapper. The slider-indicators-* option classes affects the slider-indicators child elements
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
slider-indicators-round |
Changes the default indicators to a circle |
slider-indicators-square |
Changes the default indicators to a square |
slider-indicators-outside |
Moves the indicator buttons under the slider wrapper and increases the height of the slider wrapper but not the slides them selves |
slider-indicators-dark |
Changes the indicator buttons to a dark version |
slider-indicators-highlight |
Hightlights the active indicator even more by increasing its size |
slider-indicators-sm |
Shows indicator buttons on small devices under 992px in width. By default indicator buttons are hidden on small devices. By adding this option, the indicators buttons are always visible. Since the number of indicators and number of slides does not match on small devices when showing more than one item per page, do not use this option in that case |
swiffy-slider wrapper. The slider-nav-animation-* option classes affects the animation of slides when they slide into view.
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
slider-nav-animation |
Enables animation on slides. An animation effect class is also required for animation to be enabled |
slider-nav-animation-appear |
Apear animation using opacity and scale - starting from 30% opacity and a 90% scale |
slider-nav-animation-fadein |
Fade in animation using opacity - starting from 50% opacity. Can be combined with .slider-nav-animation-scale/scaleup |
slider-nav-animation-scale |
Scale up animation using scale - starts with 90% size. Can be combined with .slider-nav-animation-fadein |
slider-nav-animation-scaleup |
Scale up animation using scale - starts with 25% size. Can be combined with .slider-nav-animation-fadein |
slider-nav-animation-turn |
Turn animation using rotateY - starts with 70deg ratotation |
slider-nav-animation-slideup |
Slide up animation using translateY - starts at 60% of the height |
slider-nav-animation-zoomout |
Zoom out animation - slides start scaled up at 130% and scale down to normal size as they enter view |
data-slider-nav-animation-threshold attribute |
Changes the default animation threshold - value is between 0-1. data-slider-nav-animation-threshold="0.3". Default value is 0.3. This setting defines how many percent of a slide should be visible before the animation starts |
| CSS class _______________________________ |
Description _______________________________ |
|---|---|
slider-nav-mousedrag |
Enables click-and-drag navigation with the mouse. Requires the extensions module to be loaded and initialized. |
| Method _______________________________ |
Description _______________________________ |
|---|---|
swiffyslider.version; |
Needs no explanation :-) |
swiffyslider.init(rootElement = document.body); |
Initializes all instances of .swiffy-slider elements and binds events to handle navigation, indicators and autoplay. By default document.body is searched for instances, but can be limited further to i.e. content area (and skip header, navigation, footer etc) to further improve init performance. |
swiffyslider.initSlider(sliderElement); |
Initializes one instance of swiffy slider wrapper. The passed element has to be a .swiffy-slider element |
swiffyslider.slide(sliderElement, next = true); |
Slides to the next slide or next page depending on the nav settings. The passed slider element has to be a .swiffy-slider element. By default this method slides next, but call it with false to slide to previous |
swiffyslider.slideToByIndicator(event); |
Called internally when an indicator button is clicked. Pass the click event. To navigate programmatically, use slideTo instead. |
swiffyslider.slideTo(sliderElement, slideIndex); |
Slides to the specified slide (index starts with 0 for first slide). The passed slider element has to be a .swiffy-slider element. |
swiffyslider.onSlideEnd(sliderElement, delegate, timeout = 125); |
Provide a callback/delegate function to get called when sliding ends. The default timeout is 125ms and should not be too low as it could cause the delegate to be called more than once on each scroll.
The passed slider element has to be a .swiffy-slider element.
|
swiffyslider.autoPlay(sliderElement, timeout, autopause); |
Manually starts autoplay for a container using the specified timeout. Autopause can be enabled. Usually auto play is handled using css option classes. This method can be used to start autoplay when the slider scrolls into view or similar. The passed slider element has to be a .swiffy-slider element. |
swiffyslider.handleIndicators(sliderElement); |
Manually updates the indicators active state to reflect the current position of the slider. The passed slider element has to be a .swiffy-slider element. |
.swiffy-slider instance or in custom css.
| Variable | Example | Description |
|---|---|---|
--swiffy-slider-item-width |
--swiffy-slider-item-width:75%; |
Calculated based on the number of slides shown, the gap, reveal etc. Should not be overriden. INFO If needed, it has to be overriden on the .slider-container element. |
--swiffy-slider-item-gap |
--swiffy-slider-item-gap:25px; |
Changes the gap between slides when enabled. Default --swiffy-slider-item-gap is 1rem, but can be any valid CSS mesurement. The --swiffy-slider-item-gap is part of the calculation of
--swiffy-slider-item-width |
--swiffy-slider-item-reveal |
--swiffy-slider-item-reveal:20%; |
Changes the width of the reveal of next and previous slides when enabled. Default --swiffy-slider-item-reveal is 8rem if previous and next is revealed and 4rem if only next is revealed (if .slider-item-snapstart is in use). The --swiffy-slider-item-reveal is part of the calculation of --swiffy-slider-item-width |
--swiffy-slider-item-ratio |
--swiffy-slider-item-ratio:100/33.3 |
Sets the ratio to a custom value. Use with .slider-item-ratio and omit use of any .slider-item-ratio-* classes |
--swiffy-slider-item-count |
--swiffy-slider-item-count:8; |
Sets the number of slides to show - same as using .slider-item-show{n} but can i.e. be set to a number higher than 6 if needed. |
--swiffy-slider-nav-light |
--swiffy-slider-nav-light:lightcyan; |
Sets the light color for navigation arrows. Default is #fff. Use to control the color of light navigation. Square and Round navigation use both colors - one for backgrond, the other for arrow color. |
--swiffy-slider-nav-dark |
--swiffy-slider-nav-dark:darkolivegreen; |
Sets the dark color for navigation arrows. Default is #333. Use to control the color of dark navigation. Square and Round navigation use both colors - one for backgrond, the other for arrow color.
Can be any color variable.
|
--swiffy-slider-nav-zoom |
--swiffy-slider-nav-zoom:1.25; |
Use to overrule the navigation arrow sizes. Default is 1 for normal sizes and .75 for small sized navigation. Set to i.e. 1.25 to make navigation arrows larger. |
--swiffy-slider-track-opacity |
--swiffy-slider-track-opacity:0.25; |
Sets the scrollbar track opacity when scrollbar is displayed |
--swiffy-slider-track-height |
--swiffy-slider-track-height:1rem; |
Sets the scrollbar track height. Default is .5rem if scrollbar (.slider-nav-scrollbar) is enabled. |
--swiffy-slider-animation-duration |
--swiffy-slider-animation-duration:0.75s |
Sets the animation duration. Default is 0.75s. Using .swiffy-slider-animation-fast sets the duration to .25s. Using .swiffy-slider-animation-slow sets the duration to 1.25s |
--swiffy-slider-animation-delay |
--swiffy-slider-animation-delay:0.5s; |
Sets the delay before animation begins when a new slide scrolls into view. Default is 0s (no delay). |
--swiffy-slider-animation-timing |
--swiffy-slider-animation-timing:ease-in-out; |
Sets the animation timing method, default is ease-in-out. |