Slider

Create a responsive carousel slider.

Slider

Create a responsive carousel slider.

The Slider component is fully responsive and supports touch and swipe navigation as well as mouse drag for desktops. It even accelerates to keep up with your pace when you click through previous and next navigation. All animations are hardware accelerated for a smoother performance.

Usage

To apply this component, add the uk-slider attribute to a container element and create a list of slides with the .uk-slider-items class. Add an image or any other content to each item.

To define the widths of the slider items, use the Width component. Either apply the .uk-child-width-* classes to define the width of all slider items or apply individual widths for each list item using the .uk-width-* classes. If no specific width is set, each item’s width depends on the dimensions of the content itself.

<div uk-slider>
    <ul class="uk-slider-items uk-child-width-1-3@s uk-child-width-1-4@">
        <li>
            <img src="" width="" height="" alt="">
        </li>
    </ul>
</div>

Note To lazy load images in the slides, use the loading="lazy" attribute. The Slider will automatically remove the attribute from images in adjacent slides.

Container

The .uk-slider-container class is responsible for the clipping of the slider items. By default, the uk-slider attribute applies this class to the same element. Alternatively, you can add this class manually to any element within the slider. That way, you can control which container clips the slider items.

<div uk-slider>

    <div class="uk-slider-container">
        <ul class="uk-slider-items uk-child-width-1-4">
            <li>
                <img src="" width="" height="" alt="">
            </li>
        </ul>
    </div>

</div>

Since the slider effect needs a clipping container, box shadows of content items are also clipped. To widen the container to prevent box-shadows from clipping, add the .uk-slider-container-offset class.

Gap

To apply a gap to the slider items, use the Grid component and add the .uk-grid class to the slider. The elements will then be spaced according to the grid gap. You can use the modifiers like .uk-grid-small to change the gap.

<div uk-slider>
    <ul class="uk-slider-items uk-child-width-1-2@s uk-child-width-1-3@m uk-grid">
        <li>
            <img src="" width="" height="" alt="">
        </li>
    </ul>
</div>

Center

By default, items of the slider always are aligned to the left. To center the list items, just add center: true to the attribute.

<div uk-slider="center: true">…</div>

Note In this example, we add the .uk-width-3-4 class to each item, which makes the slider look very similar to a slideshow.

Autoplay

To activate autoplay, just add the autoplay: true option to the attribute. You can also set the interval in milliseconds between switching slides using autoplay-interval: 6000. To pause autoplay when hovering the slider, use pause-on-hover: true.

<div uk-slider="autoplay: true">…</div>

Infinite Scrolling

By default, infinite scrolling is enabled. To disable this behavior, just add the finite: true option to the attribute.

<div uk-slider="finite: true">…</div>

Slide Sets

To loop through a set of slides instead of single items, just add sets: true to the attribute.

<div uk-slider="sets: true">…</div>

To navigate through your slides, just use the uk-slider-item attribute. To target the slides, set the attribute of every nav item to the index number of the respective slider item. The elements with the uk-slider-item attribute need to be inside the uk-slider container. Setting the attribute to next and previous will switch to the adjacent slides.

<div uk-slider>

    <ul class="uk-slider-items">…</ul>

    <a href="#" uk-slider-item="previous">…</a>
    <a href="#" uk-slider-item="next">…</a>

    <ul>
        <li uk-slider-item="0"><a href="#">…</a></li>
        <li uk-slider-item="1"><a href="#">…</a></li>
        <li uk-slider-item="2"><a href="#">…</a></li>
    </ul>

</div>

The flexibility of the Slideshow component allows you to use any of the other UIkit components to navigate through items. For example the Slidenav, Dotnav and Thumbnav components can be used to style the slideshow navigations.

If there is no item specific content in the navigation items, you can also add the .uk-slider-nav class instead of adding navigation items manually. It will generate its items automatically using <li><a href="#"></a></li> as markup. This is a useful shortcut when using the Dotnav.

<div uk-slider>

    <ul class="uk-slider-items">…</ul

    <ul class="uk-slider-nav uk-dotnav"></ul>

</div>

Note For better visibility of overlaying navigations, add the .uk-light or .uk-dark class from the Inverse component.

To place a navigation outside of a slider, add the .uk-position-center-left-out and the .uk-position-center-right-out class from the Position component to the previous and next navigation. Make sure the .uk-slider-container class, which is responsible for the clipping of the slider items, doesn’t clip the navigation, too.

<div uk-slider>

    <div class="uk-position-relative">

        <div class="uk-slider-container">
            <ul class="uk-slider-items">…</ul>
        </div>

        <a class="uk-position-center-left-out" href="#" uk-slider-item="previous">…</a>
        <a class="uk-position-center-right-out" href="#" uk-slider-item="next">…</a>

    </div>

    <ul class="uk-slider-nav uk-dotnav"></ul>

</div>

Viewport height

Adding the uk-height-viewport attribute from the Height component to the list of slider items will stretch the height of the <ul> and <li> elements to fill the whole viewport height. Since the width and height now aren’t defined by the item’s content anymore, you have to use absolute positioning for the content.

Use the Cover component so that images cover the whole item area and are clipped. The .uk-grid-match class from the Grid component matches the height of the direct child of each item. This is useful in this example, since the child element now applies the same width and height as the list item.

<div uk-slider>
    <ul class="uk-slider-items uk-child-width-1-3@m uk-grid-match" uk-height-viewport="min-height: 300">
        <li>
            <div class="uk-cover-container">
                <img src="" alt="" uk-cover>
            </div>
        </li>
    </ul>
</div>

Note This example is set to 70% of the viewport height.

Content

The slider is not restricted to images. Any content can be used like text, videos, images with text overlays or ken burns effect. Here is an example using the Card component.

Note Since the slider effect needs a clipping container, box shadows of content items are also clipped. To widen the container to prevent box-shadows from clipping, add the .uk-slider-container-offset class. Alternatively, use the uk-slider="center: true" mode if your content items have a box shadow.

Content overlays

Add content overlays using the Position component. It allows you to place the content anywhere inside the slide.

<div uk-slider>
    <ul class="uk-slider-items">
        <li>
            <img src="" width="" height="" alt="">
            <div class="uk-position-center">

                <!-- The content goes here -->

            </div>
        </li>
    </ul>
</div>

Note To adapt your content for better visibility on each image, add the .uk-light or .uk-dark class from the Inverse component or use the Overlay to add any style to the overlay box.

Content parallax

Add the uk-slider-parallax attribute to any element inside the slides to animate it together with the slider animation. Add an option with the desired animation values for each CSS property you want to animate. Define at least one start and end value. It can be done by passing two values separated by a comma.

This functionality is inherited from the Parallax component, and it allows animating CSS properties depending on the scroll position of the slider animation. Take a look at the possible properties that can be animated.

<div uk-slider>
    <ul class="uk-slider-items">
        <li>
            <img src="" width="" height="" alt="">
            <div class="uk-position-center">

                <div uk-slider-parallax="x: 100,-100">

                    <!-- The content goes here -->

                </div>

            </div>
        </li>
    </ul>
</div>

In the example above, the content will start at 100 and animate half way to 0 while the slide moves in. When the slide starts again to move out, the content will continue to animate to -100. This works because the start and end values have the same distance. For different distances, three values are needed: Start (Slide animates in), Middle (Slide is centered), End (Slide animates out).

<div uk-slider-parallax="x: 300,0,-100">…</div>

The next example defines different in and out animations. The content slides in by moving from 100 to 0 and fades out from 1 to 0.

<div uk-slider-parallax="x: 100,0,0; opacity: 1,1,0">…</div>

Content transitions

Add clsActivated: uk-transition-active to the attribute to trigger transition classes from the Transition component automatically inside slides. Contrary to the parallax effect, transitions are not attached to the slider animation and start playing independently after the slider animation.

<div uk-slider="clsActivated: uk-transition-active">
    <ul class="uk-slider-items">
        <li>
            <img src="" width="" height="" alt="">
            <div class="uk-position-bottom">

                <div class="uk-transition-slide-bottom">

                    <!-- The content goes here -->

                </div>

            </div>
        </li>
    </ul>
</div>

Together with the Overlay component, content transitions are used to build a classic caption for the slider.

Toggle on hover

To toggle transitions on hover, use the .uk-transition-toggle class from the Transition component and tabindex="0". This will trigger the transition when the element is hovered or focused.

<div uk-slider>
    <ul class="uk-slider-items">
        <li class="uk-transition-toggle" tabindex="0">
            <img src="" width="" height="" alt="">
            <div class="uk-position-bottom">

                <div class="uk-transition-slide-bottom">

                    <!-- The content goes here -->

                </div>

            </div>
        </li>
    </ul>
</div>

Component options

Any of these options can be applied to the component attribute. Separate multiple options with a semicolon. Learn more

Slider

OptionValueDefaultDescription
autoplayBooleanfalseSlider autoplays.
autoplay-intervalNumber7000The delay between switching slides in autoplay mode.
centerBooleanfalseCenter the active slide.
draggableBooleantrue Enable pointer dragging.
easingStringeaseThe animation easing (CSS timing functions or cubic-bezier).
finiteBooleanfalseDisable infinite sliding.
indexNumber0Slider item to show. 0 based index.
pause-on-hoverBooleantruePause autoplay mode on hover.
setsBooleanfalseSlide in sets.
velocityNumber1The animation velocity (pixel/ms).

JavaScript

Learn more about JavaScript components.

Initialization

UIkit.slider(element, options);

Events

The following events will be triggered on elements with this component attached:

NameDescription
beforeitemshowFires before an item is shown.
itemshowFires after an item is shown.
itemshownFires after an item’s show animation has completed.
beforeitemhideFires before an item is hidden.
itemhideFires after an item’s hide animation has started.
itemhiddenFires after an item’s hide animation has completed.

Methods

The following methods are available for the component:

Show

UIkit.slider(element).show(index);

Shows the slider item.

startAutoplay

UIkit.slider(element).startAutoplay();

Starts the slider autoplay.

stopAutoplay

UIkit.slider(element).stopAutoplay();

Stops the slider autoplay.