HtmlForgeX

API Reference

Class

CarouselSettings

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Settings sub-builder for TablerCarousel.

Inheritance

  • Object
  • CarouselSettings

Methods

public CarouselSettings Behavior(TablerCarouselBehaviorPreset preset) #
Returns: CarouselSettings

Applies a typed behavior preset for ride/pause/input/wrap defaults.

Parameters

preset HtmlForgeX.TablerCarouselBehaviorPreset requiredposition: 0
public CarouselSettings Controls(Boolean show = true) #
Returns: CarouselSettings

Show/hide prev/next controls.

Parameters

show System.Boolean = true optionalposition: 0
public CarouselSettings ControlsPlacement(TablerCarouselControlsPlacement placement) #
Returns: CarouselSettings

Configures where navigation controls are rendered relative to slides.

Parameters

placement HtmlForgeX.TablerCarouselControlsPlacement requiredposition: 0
public CarouselSettings ControlsVisual(TablerCarouselControlsVisual visual) #
Returns: CarouselSettings

Configures the visual style of navigation controls.

Parameters

visual HtmlForgeX.TablerCarouselControlsVisual requiredposition: 0
public CarouselSettings Dark(Boolean enable = true) #
Returns: CarouselSettings

Enable dark carousel controls/captions.

Parameters

enable System.Boolean = true optionalposition: 0
public TablerCarousel End() #
Returns: TablerCarousel

Return to the root carousel builder.

public CarouselSettings Fade(Boolean enable = true) #
Returns: CarouselSettings

Enable Bootstrap fade transition.

Parameters

enable System.Boolean = true optionalposition: 0
public CarouselSettings Indicators(Boolean show = true) #
Returns: CarouselSettings

Show/hide slide indicators.

Parameters

show System.Boolean = true optionalposition: 0
public CarouselSettings IndicatorsVisual(TablerCarouselIndicatorsVisual visual) #
Returns: CarouselSettings

Configures the visual style of slide indicators.

Parameters

visual HtmlForgeX.TablerCarouselIndicatorsVisual requiredposition: 0
public CarouselSettings Interval(Int32 milliseconds) #
Returns: CarouselSettings

Interval between slides in milliseconds (maps to data-bs-interval).

Parameters

milliseconds System.Int32 requiredposition: 0
public CarouselSettings Keyboard(Nullable<Boolean> enable = true) #
Returns: CarouselSettings

Enable/disable keyboard navigation (maps to data-bs-keyboard).

Parameters

enable System.Nullable{System.Boolean} = true optionalposition: 0
public CarouselSettings PauseOnHover(Boolean enable = true) #
Returns: CarouselSettings

Pause on hover behavior (maps to data-bs-pause: "hover"/"false").

Parameters

enable System.Boolean = true optionalposition: 0
public CarouselSettings Ride(TablerCarouselRide ride) #
Returns: CarouselSettings

Control auto cycling behavior (maps to data-bs-ride).

Parameters

ride HtmlForgeX.TablerCarouselRide requiredposition: 0
public CarouselSettings Touch(Nullable<Boolean> enable = true) #
Returns: CarouselSettings

Enable/disable touch swipe support (maps to data-bs-touch).

Parameters

enable System.Nullable{System.Boolean} = true optionalposition: 0
public CarouselSettings Wrap(Nullable<Boolean> enable = true) #
Returns: CarouselSettings

Enable/disable wrap-around cycling (maps to data-bs-wrap).

Parameters

enable System.Nullable{System.Boolean} = true optionalposition: 0