Class Carousel

Namespace

BootstrapBlazor.Components

Assembly

BootstrapBlazor.dll

Carousel 组件

public class Carousel : BootstrapModuleComponentBase, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable

Inheritance

object

ComponentBase

BootstrapComponentBase

IdComponentBase

BootstrapModuleComponentBase

Carousel

Implements

IComponent

IHandleAfterRender

IHandleEvent

IAsyncDisposable

Inherited Members

BootstrapModuleComponentBase.OnInitialized()

BootstrapModuleComponentBase.OnAfterRenderAsync(bool)

BootstrapModuleComponentBase.OnLoadJSModule()

BootstrapModuleComponentBase.InvokeVoidAsync(string, params object[])

BootstrapModuleComponentBase.InvokeVoidAsync(string, TimeSpan, params object[])

BootstrapModuleComponentBase.InvokeVoidAsync(string, CancellationToken, params object[])

BootstrapModuleComponentBase.InvokeAsync<TValue>(string, params object[])

BootstrapModuleComponentBase.InvokeAsync<TValue>(string, TimeSpan, params object[])

BootstrapModuleComponentBase.InvokeAsync<TValue>(string, CancellationToken, params object[])

BootstrapModuleComponentBase.DisposeAsync(bool)

BootstrapModuleComponentBase.DisposeAsync()

BootstrapModuleComponentBase.Module

BootstrapModuleComponentBase.ModulePath

BootstrapModuleComponentBase.AutoInvokeInit

BootstrapModuleComponentBase.AutoInvokeDispose

BootstrapModuleComponentBase.Interop

IdComponentBase.RetrieveId()

IdComponentBase.Id

IdComponentBase.ComponentIdGenerator

BootstrapComponentBase.AdditionalAttributes

BootstrapComponentBase.ErrorLogger

BootstrapComponentBase.JSRuntime

BootstrapComponentBase.IsNotRender

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ExpandableNodeExtensions.SetChildrenCheck<TNode, TItem>(TNode, CheckboxState, TreeNodeCache<TNode, TItem>?)

ExpandableNodeExtensions.SetParentCheck<TNode, TItem>(TNode, CheckboxState, TreeNodeCache<TNode, TItem>?)

ExpandableNodeExtensions.SetParentExpand<TNode, TItem>(TNode, bool)

Constructors

Carousel()

public Carousel()

Properties

ChildContent

获得/设置 子组件 要求使用 CarouselItem

[Parameter]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

DisableTouchSwiping

获得/设置 是否禁用移动端手势滑动 默认 false

[Parameter]
public bool DisableTouchSwiping { get; set; }

Property Value

bool

HoverPause

获得/设置 鼠标悬停时是否暂停播放 默认 true

[Parameter]
public bool HoverPause { get; set; }

Property Value

bool

Images

获得 Images 集合

[Parameter]
public IEnumerable<string> Images { get; set; }

Property Value

IEnumerable<string>

IsFade

获得/设置 是否采用淡入淡出效果 默认为 false

[Parameter]
public bool IsFade { get; set; }

Property Value

bool

NextIcon

获得/设置 下一页图标

[Parameter]
public string? NextIcon { get; set; }

Property Value

string

OnClick

获得/设置 点击 Image 回调委托

[Parameter]
public Func<string, Task>? OnClick { get; set; }

Property Value

Func<string, Task>

OnSlideChanged

获得/设置 幻灯片切换后回调方法

[Parameter]
public Func<int, Task>? OnSlideChanged { get; set; }

Property Value

Func<int, Task>

PlayMode

获得/设置 自动播放方式 默认 AutoPlayOnload

[Parameter]
public CarouselPlayMode PlayMode { get; set; }

Property Value

CarouselPlayMode

PreviousIcon

获得/设置 上一页图标

[Parameter]
public string? PreviousIcon { get; set; }

Property Value

string

ShowControls

获得/设置 是否显示控制按钮 默认 true

[Parameter]
public bool ShowControls { get; set; }

Property Value

bool

ShowIndicators

获得/设置 是否显示指示标志 默认 true

[Parameter]
public bool ShowIndicators { get; set; }

Property Value

bool

Width

获得/设置 内部图片的宽度

[Parameter]
public string? Width { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

InvokeInitAsync()

call JavaScript method

protected override Task InvokeInitAsync()

Returns

Task

OnClickImage(string)

点击 Image 是触发此方法

protected Task OnClickImage(string imageUrl)

Parameters

imageUrl string

Returns

Task

OnParametersSet()

OnParametersSet 方法

protected override void OnParametersSet()

TriggerSlideChanged(int)

幻灯片切换事件回调 由 JavaScript 调用

[JSInvokable]
public ValueTask TriggerSlideChanged(int index)

Parameters

index int

Returns

ValueTask