Edit on Github

Carousel

in namespace DotVVM.Framework.Controls.Bootstrap4

Renders a Bootstrap carousel widget.

Usage & Scenarios

Renders a Bootstrap carousel widget.

https://getbootstrap.com/docs/4.3/components/carousel/

Sample 1: Basic Carousel

Carousel images have to be placed inside the Items property. It is a control default property so you can place the <bs:CarouselItem> elements directly inside the <bs:Carousel> control. Each image is defined using the CarouselItem control.

The CarouselItem has the IsActive that specifies which image will be displayed first.

<div style="height: 428px; width: 640px;">

    <bs:Carousel>
        <bs:CarouselItem IsActive="true">
            <bs:Image ImageUrl="~/Images/LA.jpg" />
        </bs:CarouselItem>
    
        <bs:CarouselItem>
            <bs:Image ImageUrl="~/Images/NY.jpg" />
        </bs:CarouselItem>
    
        <bs:CarouselItem>
            <bs:Image ImageUrl="~/Images/Miami.jpg" />
        </bs:CarouselItem>
    </bs:Carousel>

</div>

Sample 2: Carousel Settings

The Carousel control has the following properties:

  • The Animation property specifies which transitions between slides should be used - Slide, Fade or None.

  • The AutoSlideInterval property sets the interval of automatic transitions in seconds. If this property is not set, the user has to switch the slides manually.

  • The RenderSideControls property specifies whether the left and right controls which switch the slides will be rendered.

  • The RenderIndicators property specifies whether the bottom active slide indicators should be rendered.

  • The PauseOnHover property indicates whether the animation should be paused when the mouse cursor is over the carousel.

  • The CycleItems property specifies whether the animation should continue when it reaches the last slide.

<div style="height: 428px; width: 640px;">

    <bs:Carousel RenderSideControls="false" RenderIndicators="true" 
                 Animation="Fade" AutoSlideInterval="3" 
                 PauseOnHover="false" CycleItems="false">
                 
        <bs:CarouselItem IsActive="true">
            <bs:Image ImageUrl="~/Images/LA.jpg" />
        </bs:CarouselItem>
        
        <bs:CarouselItem>
            <bs:Image ImageUrl="~/Images/NY.jpg" />
        </bs:CarouselItem>
        
        <bs:CarouselItem>
            <bs:Image ImageUrl="~/Images/Miami.jpg" />
        </bs:CarouselItem>
    </bs:Carousel>

</div>

Sample 3: Side Controls

The RightControlTemplate and LeftControlTemplate you can specify your own buttons which will used instead the default ones.

<div style="height: 428px; width: 640px;">

    <bs:Carousel>
        <Items>
        
            <bs:CarouselItem IsActive="true">
                <bs:Image ImageUrl="~/Images/LA.jpg" />
            </bs:CarouselItem>
        
            <bs:CarouselItem>
                <bs:Image ImageUrl="~/Images/NY.jpg" />
            </bs:CarouselItem>
        
            <bs:CarouselItem>
                <bs:Image ImageUrl="~/Images/Miami.jpg" />
            </bs:CarouselItem>
        
        </Items>

        <RightControlTemplate>
            <span aria-hidden="true" style="color: white">&gt; Next</span>
        </RightControlTemplate>

        <LeftControlTemplate>
            <span aria-hidden="true" style="color: white">&lt; Previous</span>
        </LeftControlTemplate>

    </bs:Carousel>

</div>

Sample 4: Captions

The Caption or the CaptionTemplate properties can be used to set description of the image.

<div style="height: 428px; width: 640px;">

    <bs:Carousel>
    
        <bs:CarouselItem>
            <CaptionTemplate>
                <h1>Los Angeles</h1>
                <p>On of the most beautiful cities on the west coast.</p>
            </CaptionTemplate>
            
            <bs:Image ImageUrl="~/Images/LA.jpg" />
        </bs:CarouselItem>
        
        <bs:CarouselItem Caption="{value: Caption}">
            <bs:Image ImageUrl="~/Images/NY.jpg" />
        </bs:CarouselItem>
        
    </bs:Carousel>

</div>
using DotVVM.Framework.ViewModel;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap.Carousel.sample4
{
    public class ViewModel : DotvvmViewModelBase
    {
        public string Caption { get; set; } = "New York";
    }
}

Sample 5: Carousel Data-binding

The Carousel slides can also be loaded from a collection in the viewmodel. Use the DataSource property to specify the source collection.

Then use the ImageUrlBinding to specify which property of the collection item will be used as the URL of the image.

Similarly, the CaptionBinding specifies which property will be the slide caption. Alternatively, you can use CaptionTemplate property to define a custom template for slide captions.

Finally the IsActiveBinding specifies which of the slides will be displayed first.

<div style="height: 428px; width: 640px;">

    <bs:Carousel DataSource="{value: Images}" 
                ImageUrlBinding="{value: Url}" 
                CaptionBinding="{value: Caption}"
                IsActiveBinding="{value: IsActive}" />

</div>
public class ViewModel : DotvvmViewModelBase
{
    public ImageData[] Images { get; set; } = new[]
    {
        new ImageData("../../Images/LA.jpg", "Los Angeles"),
        new ImageData("../../Images/NY.jpg", "New York", true),
        new ImageData("../../Images/Miami.jpg", "Miami")
    };
}

public class ImageData
{
    public ImageData()
    {
    }

    public ImageData(string url, string caption, bool active = false)
    {
        IsActive = active;
        Url = url;
        Caption = caption;
    }

    public string Caption { get; set; }
    public bool IsActive { get; set; }
    public string Url { get; set; }
}

Properties

Name Type Description Notes Default Value
property icon Animation CarouselAnimationType Gets or sets which animation will be used. Allows to set animation to None.
attribute
inner element
static value
bindable
default
 Slide
property icon AutoSlideInterval Double? Gets or sets interval (in seconds) between changing slides.
attribute
inner element
static value
bindable
default
 null
property icon CaptionBinding IValueBinding Gets or sets the caption template for carousel items bound from DataSource.
attribute
inner element
static value
bindable
default
 null
property icon CaptionTemplate ITemplate Gets or sets the caption template for carousel items bound from DataSource.
attribute
inner element
static value
bindable
default
 null
property icon CycleItems Boolean Gets or sets whether the carousel should cycle continuously or have hard stops.
attribute
inner element
static value
bindable
default
 True
property icon DataSource Object Gets or sets the source collection or a GridViewDataSet that contains data in the control.
attribute
inner element
static value
bindable
default
 null
property icon ImageAlternateTextBinding IValueBinding Gets or sets a value binding that points to a property that contains the Alternate Text of the image.
attribute
inner element
static value
bindable
default
 null
property icon ImageUrlBinding IValueBinding Gets or sets a value binding that points to a property that contains the URL of the image.
attribute
inner element
static value
bindable
default
 null
property icon IsActiveBinding IValueBinding Gets or sets a value binding that points to a property indicating whether the item is active or not.
attribute
inner element
static value
bindable
default
 null
property icon Items List<ICarouselItem> Gets or sets the individual slides inside the control.
attribute
inner element
static value
bindable
default
 null
property icon LeftControlTemplate ITemplate Gets or sets the template for the "move left" control.
attribute
inner element
static value
bindable
default
 null
property icon PauseOnHover Boolean Gets or sets whether changing of items shall be paused on hover.
attribute
inner element
static value
bindable
default
 True
property icon RenderIndicators Boolean Gets or sets whether the dots indicating active slide will be rendered.
attribute
inner element
static value
bindable
default
 True
property icon RenderSideControls Boolean Gets or sets whether navigation controls will be rendered.
attribute
inner element
static value
bindable
default
 True
property icon RightControlTemplate ITemplate Gets or sets the template for the "move right" control.
attribute
inner element
static value
bindable
default
 null

HTML produced by the control

Information about cookies

We use cookies to analyze our traffic, personalize content and ads, and to provide some social media features. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you've provided to them or that they've collected from your use of their services.

Edit options

Information about cookies

We use cookies to analyze our traffic, personalize content and ads, and to provide some social media features. We also share information about your use of our site with our social media, advertising and analytics partners who may combine it with other information that you've provided to them or that they've collected from your use of their services.

Choose which cookies you want to enable

Necessary cookies Always allowed

Necessary cookies are essential and maintain information based on your activity on our site, like remembering your signed in account, selection of your language, or products added to the shopping cart. The website cannot work properly without these cookies.

Google Analytics

We use these cookies to measure, collect, analyse and report how users interact with our sites to better understand their behavior. Thanks to this, we can improve the site and provide better experience. The analytics service is provided by Google Inc.

Google Ads

We use these cookies to measure conversions from our advertisement and banners distributed via Google Ads. This allows us to better target the ads and make them more relevant to you.

Facebook Pixel

We use these cookies to measure conversions from our advertisement and banners distributed via Facebook. This allows us to better target the ads and make them more relevant to you.

Smartlook

We use these cookies to measure, collect, analyse and report how users interact with our sites to better understand their behavior. Thanks to this, we can improve the site and provide better experience. The analytics service is provided by Smartlook.

Google ads user data

Google ads ad personalization