Navigators and Indicators

20 Jul 202324 minutes to read

The navigators and indicators are used to transition the slides manually.

Show or hide previous and next button

In navigators, the previous and next slide transition buttons are used to perform slide transitions manually. You can show/hide the navigators using the buttonsVisibility property. The possible property values are as follows:

  • Hidden – the navigator’s buttons are not visible.
  • Visible – the navigator’s buttons are visible.
  • VisibleOnHover – the navigator’s buttons are visible only when hovering over the carousel.

The following example depicts the code to hide the navigators in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" buttonsVisibility="Hidden">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel hidden navigators

Show previous and next button on hover

In the carousel, you can show the previous and next buttons only on mouse hover using the buttonsVisibility property. The following example depicts the code to show the navigators on mouse hover in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" buttonsVisibility="VisibleOnHover">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel visible on hover navigators

Previous and next button template

Template options are provided to customize the previous button using previousButtonTemplate and the next button using nextButtonTemplate. The following example depicts the code for applying the template to previous and next buttons in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" previousButtonTemplate='<button id="previous"></button>' nextButtonTemplate='<button id="next"></button>'>
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<script type="text/javascript">
    document.addEventListener('DOMContentLoaded', function () {
        var prevBtn = new ej.buttons.Button({ cssClass: 'e-flat e-round', iconCss: 'e-icons e-chevron-left-double' });
        prevBtn.appendTo('#previous');
        var nextBtn = new ej.buttons.Button({ cssClass: 'e-flat e-round', iconCss: 'e-icons e-chevron-right-double' });
        nextBtn.appendTo('#next');
    });
</script>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel navigators template

Indicators

Show or hide indicators

In indicators, the total slides and current slide state have been depicted. You can show/hide the indicators using the showIndicators property. The following example depicts the code to hide the indicators in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" showIndicators="false">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel hidden indicators

Indicators template

Template option is provided to customize the indicators by using the indicatorsTemplate property. The following example depicts the code for applying a template to indicators in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" indicatorsTemplate="<div class='indicator' indicator-index='${index}'></div>">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>

<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }

    .e-carousel .e-carousel-indicators .e-indicator-bars .e-indicator-bar.e-template .indicator {
        background-color: #ececec;
        border-radius: 0.25rem;
        cursor: pointer;
        height: 0.5rem;
        margin: 0.5rem;
        width: 1.5rem;
    }

    .e-carousel .e-carousel-indicators .e-indicator-bars .e-indicator-bar.e-active .indicator {
        background-color: #3c78ef;
    }
</style>

Carousel indicators template

Showing preview of slide in indicator

You can customize the indicators by showing the preview image of each slide using the indicatorsTemplate property. The following example depicts the code for showing the preview image using a template for indicators in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" slideChanged="onSlideChanged" indicatorsTemplate="#indicatorTemplate">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>

<script type="text/x-template" id="indicatorTemplate">
    <div class="indicator" indicator-index="${index}">
        <div class="preview-content">${getContent(data.index)}</div>
    </div>
</script>

<script type="text/javascript">
    window.getContent = function (index) {
        var birds = ['Slide 1', 'Slide 2', 'Slide 3', 'Slide 4', 'Slide 5'];
        return birds[index];
    };

    function onSlideChanged(args) {
        var carouselObj = document.querySelector(".e-carousel").ej2_instances[0];
        var indicators = carouselObj.element.querySelector('.e-carousel-indicators');
        ej.base.removeClass(indicators.querySelectorAll('.indicator'), 'active');
        ej.base.addClass([(indicators.querySelector('[data-index="' + args.currentIndex + '"]').children[0])], 'active');
    }

</script>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }

    .e-carousel .e-carousel-items,
    .e-carousel .e-carousel-navigators {
        height: calc(100% - 3rem);
    }

        .e-carousel .e-carousel-navigators .e-previous,
        .e-carousel .e-carousel-navigators .e-next,
        .e-carousel .e-carousel-navigators .nav-btn {
            padding: 0;
        }

            .e-carousel .e-carousel-navigators .nav-btn:active,
            .e-carousel .e-carousel-navigators .nav-btn:focus,
            .e-carousel .e-carousel-navigators .nav-btn:hover {
                background-color: transparent !important;
                color: inherit;
            }

        .e-carousel .e-carousel-navigators svg {
            fill: none;
            stroke: currentColor;
            stroke-linecap: square;
            stroke-width: 8px;
            height: 2rem;
            vertical-align: middle;
            width: 2rem;
        }

        .e-carousel .e-carousel-navigators .e-previous svg {
            transform: rotate(180deg);
        }

    .e-carousel .e-carousel-indicators .e-indicator-bars .e-indicator-bar .indicator {
        background-color: #ececec;
        border: 1px solid black;
        border-radius: 0.25rem;
        cursor: pointer;
        height: 3.5rem;
        margin: 0.5rem;
        width: 5rem;
    }

    .e-carousel .e-carousel-indicators .e-indicator-bars .e-indicator-bar.e-active .indicator {
        background-color: #c1cdda;
    }

    .preview-content {
        align-items: center;
        display: flex;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators template preview

Indicators Types

Choose different types of indicators available using the indicatorsType property. The indicator types are categorized as follows:

Default Indicator

A default indicator in a carousel is a set of dots that indicate the current position of the slide in the carousel. The Default indicator can be achieved by setting the indicatorsType to Default.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Default">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type default

Dynamic Indicator

A dynamic indicator in a carousel provides visual cues or markers that dynamically change or update to indicate the current position. The Dynamic indicator can be achieved by setting the indicatorsType to Dynamic.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Dynamic">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type dynamic

Fraction Indicator

The fraction indicator type displays the current slide index and total slide count as a fraction. The Fraction indicator can be achieved by setting the indicatorsType to Fraction.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Fraction">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type fraction

Progress Indicator

The Progress Indicator type displays the current slide as a progress bar. The Progress indicator can be achieved by setting the indicatorsType to Progress.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Progress">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type progress

Play button

Show or hide the play button

In the carousel, autoPlay actions have been controlled by using the showPlayButton property in the user interface. When you enable this property, the slide transitions are controlled using this play and pause button. This property depends on the buttonsVisibility property. The following example depicts the code to show the play button in the carousel.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" showPlayButton="true">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel play button

Indicators Types

Choose different types of indicators available using the indicatorsType property. The indicator types are categorized as follows:

Default Indicator

A default indicator in a carousel is a set of dots that indicate the current position of the slide in the carousel. The Default indicator can be achieved by setting the indicatorsType to Default.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Default">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type default

Dynamic Indicator

A dynamic indicator in a carousel provides visual cues or markers that dynamically change or update to indicate the current position. The Dynamic indicator can be achieved by setting the indicatorsType to Dynamic.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Dynamic">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type dynamic

Fraction Indicator

The fraction indicator type displays the current slide index and total slide count as a fraction. The Fraction indicator can be achieved by setting the indicatorsType to Fraction.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Fraction">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type fraction

Progress Indicator

The Progress Indicator type displays the current slide as a progress bar. The Progress indicator can be achieved by setting the indicatorsType to Progress.

<div class="container">
    <div class="control-container">
        <ejs-carousel id="carousel" autoPlay="false" indicatorsType="Progress">
            <e-carousel-items>
                <e-carousel-item template='<div class="slide-content">Slide 1</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 2</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 3</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 4</div>'></e-carousel-item>
                <e-carousel-item template='<div class="slide-content">Slide 5</div>'></e-carousel-item>
            </e-carousel-items>
        </ejs-carousel>
    </div>
</div>
<style>
    .control-container {
        background-color: #adb5bd;
        height: 300px;
        margin: 0 auto;
        width: 500px;
    }

    .e-carousel .slide-content {
        align-items: center;
        display: flex;
        font-size: 1.25rem;
        height: 100%;
        justify-content: center;
    }
</style>

Carousel indicators type progress

Play button template

Template option is provided to customize the play button by using the playButtonTemplate property. The following example depicts the code for applying a template to play Button in the carousel.

<div class="control-container">
    <ejs-carousel id="carousel" showPlayButton="true" playButtonTemplate='<div id="play"></div>'>
        <e-carousel-items>
            <e-carousel-item template='<figure class="img-container"><img src="https://ej2.syncfusion.com/products/images/carousel/cardinal.png" alt="cardinal" style="height:100%;width:100%;" /><figcaption class="img-caption">Cardinal</figcaption></figure>'></e-carousel-item>
            <e-carousel-item template='<figure class="img-container"><img src="https://ej2.syncfusion.com/products/images/carousel/hunei.png" alt="kingfisher" style="height:100%;width:100%;" /><figcaption class="img-caption">Kingfisher</figcaption></figure>'></e-carousel-item>
            <e-carousel-item template='<figure class="img-container"><img src="https://ej2.syncfusion.com/products/images/carousel/costa-rica.png" alt="keel-billed-toucan" style="height:100%;width:100%;" /><figcaption class="img-caption">Keel-billed-toucan</figcaption></figure>'></e-carousel-item>
            <e-carousel-item template='<figure class="img-container"><img src="https://ej2.syncfusion.com/products/images/carousel/kaohsiung.png" alt="yellow-warbler" style="height:100%;width:100%;" /><figcaption class="img-caption">Yellow-warbler</figcaption></figure>'></e-carousel-item>
            <e-carousel-item template='<figure class="img-container"><img src="https://ej2.syncfusion.com/products/images/carousel/bee-eater.png" alt="bee-eater" style="height:100%;width:100%;" /><figcaption class="img-caption">Bee-eater</figcaption></figure>'></e-carousel-item>
        </e-carousel-items>
    </ejs-carousel>
</div>
<script type="text/javascript">
    document.addEventListener('DOMContentLoaded', function () {
        var carouselObj = document.querySelector(".e-carousel").ej2_instances[0];
        var button = new ej.buttons.Button({ cssClass: 'e-play-pause-btn', content: "Pause" });
        button.appendTo('#play');
        button.element.onclick = () => {
            if (carouselObj.autoPlay) {
                button.content = "Play";
                carouselObj.autoPlay = false;
            } else {
                button.content = "Pause";
                carouselObj.autoPlay = true;
            }
        };
    });
</script>
<style>
    .control-container {
        height: 360px;
        margin: 0 auto;
        width: 600px;
    }

    .img-container {
        height: 100%;
        margin: 0;
    }

    .img-caption {
        color: #fff;
        font-size: 1rem;
        position: absolute;
        bottom: 3rem;
        width: 100%;
        text-align: center;
    }

    .e-play-pause-btn {
        border-radius: unset !important;
    }
</style>

Carousel play button template

NOTE

View Sample in GitHub.