New to Telerik UI for BlazorStart a free 30-day trial

A component that lets you display data as swipable pages with arrows, pager, and looping. Supports automatic page change with interval, RTL-aware navigation, theming, and two-way page binding via Page/PageChanged.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

C#
public class TelerikCarousel<TItem> : DataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikCarousel<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataBoundComponent<TItem>.Dispose()DataBoundComponent<TItem>.Rebind()DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.OnAfterRenderAsync(bool)BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)...

Constructors

C#
public TelerikCarousel()

Methods

C#
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

C#
protected override void OnAfterRender(bool firstRender)
Parameters:firstRenderbool

Overrides: ComponentBase.OnAfterRender(bool)

C#
protected override Task OnParametersSetAsync()
Returns:

Task

Overrides: DataBoundComponent<TItem>.OnParametersSetAsync()

C#
public override Task SetParametersAsync(ParameterView parameters)
Parameters:parametersParameterViewReturns:

Task

Overrides: DataBoundComponent<TItem>.SetParametersAsync(ParameterView)

Properties

Defines whether the arrows should be visible. Default value is true.

C#
[Parameter]
public bool Arrows { get; set; }

Defines whether automatic page change should be enabled. Default value is true.

C#
[Parameter]
public bool AutomaticPageChange { get; set; }

Defines the interval between automatic page changes. Default value is 5000.

C#
[Parameter]
public int AutomaticPageChangeInterval { get; set; }

Defines the height of the component.

C#
[Parameter]
public string Height { get; set; }
C#
public string HeightStyle { get; }

Defines whether looping pages should be enabled. Default value is true.

C#
[Parameter]
public bool LoopPages { get; set; }

Defines the current page of the Carousel. Default value is 1.

C#
[Parameter]
public int Page { get; set; }

Defines whether the pager should be visible. Default value is true.

C#
[Parameter]
public bool Pageable { get; set; }

Triggers when the page has changed.

C#
[Parameter]
public EventCallback<int> PageChanged { get; set; }
C#
public string StyleToRender { get; }

Defines the default template of the Carousel.

C#
[Parameter]
public RenderFragment<TItem> Template { get; set; }

Defines the pager overlay. Default value is Light.

C#
[Parameter]
public string ThemeColor { get; set; }
C#
public string ThemeColorClass { get; }

Defines the width of the component.

C#
[Parameter]
public string Width { get; set; }
C#
public string WidthStyle { get; }