BptCarousel

API reference for BptCarousel — parameters, event callbacks, and related configuration.

Home / Documentation / BptCarousel
Images & Animation

BptCarousel

Open demo →

Parameters

NameTypeFlagsDescription
BptAppStateBptRootComponentBaseCascadingNullable
CultureStateBptCultureStateCascadingNullable
ChildContentRenderFragmentNullable
Widthstring
Heightstring
AutoPlaybool
AutoPlayIntervalint
Loopbool
LoopModeCarouselLoopMode
PauseOnHoverbool
ShowArrowsbool
ShowPaginationbool
SelectedIndexint
CssClassstring
Framelessbool
TransitionSpeeddouble
OnEnterEffectsList<BptEffect>Nullable
OnExitEffectsList<BptEffect>Nullable
ShowExportGifbool
ExportLoopbool
ShowImportGifbool
GifSourcestringNullable
ModeBptCarouselMode
MarqueeSpeeddouble
MarqueeDirectionBptMarqueeDirection
MarqueeFadeEdgesbool
MarqueeItemWidthstringNullable

Event callbacks

NameTypeFlagsDescription
SelectedIndexChangedEventCallback<int>
OnExportProgressEventCallback<int>
OnExportCompleteEventCallback<string>
OnGifImportedEventCallback
OnGifClearedEventCallback

Sub-components

BptCarouselItem

Parameters

NameTypeFlagsDescription
ParentBptCarouselCascadingNullable
ChildContentRenderFragmentNullable
OnEnterEffectsList<BptEffect>Nullable
OnExitEffectsList<BptEffect>Nullable
TransitionSpeeddouble
Durationint?Nullable
PauseOnHoverbool?Nullable
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please reload the page.