Skip to main content

CarouselProps

Struct CarouselProps 

Source
pub struct CarouselProps {
    pub active: Signal<usize>,
    pub slides: Vec<CarouselSlide>,
    pub indicators: bool,
    pub controls: bool,
    pub fade: bool,
    pub dark: bool,
    pub ride: bool,
    pub interval: u64,
    pub class: String,
}
Expand description

Bootstrap Carousel component — signal-driven, no JavaScript.

Supports slide/fade transitions, auto-play with configurable interval, pause on hover, keyboard navigation (arrow keys), and touch swipe.

§Bootstrap HTML → Dioxus

HTMLDioxus
<div class="carousel slide" data-bs-ride="carousel">Carousel { active: signal, ride: true, slides: vec![...] }
<div class="carousel-item"><img src="..." class="d-block w-100">CarouselSlide { src: "...".into(), alt: "...".into(), ... }
<div class="carousel slide carousel-fade">Carousel { fade: true, ... }
data-bs-interval="3000"interval: 3000
let active = use_signal(|| 0usize);
rsx! {
    Carousel {
        active: active,
        slides: vec![
            CarouselSlide { src: "/img/1.jpg".into(), alt: "First".into(),
                caption_title: Some("First slide".into()), caption_text: None },
            CarouselSlide { src: "/img/2.jpg".into(), alt: "Second".into(),
                caption_title: None, caption_text: None },
        ],
        ride: true,
        interval: 5000,
    }
}

Fields§

§active: Signal<usize>

Signal controlling the active slide index.

§slides: Vec<CarouselSlide>

Slide definitions.

§indicators: bool

Show indicator dots.

§controls: bool

Show prev/next controls.

§fade: bool

Crossfade transition instead of slide.

§dark: bool

Dark variant for lighter background images.

§ride: bool

Enable auto-play cycling.

§interval: u64

Auto-play interval in milliseconds (default 5000).

§class: String

Additional CSS classes.

Implementations§

Source§

impl CarouselProps

Source

pub fn builder() -> CarouselPropsBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building CarouselProps. On the builder, call .active(...), .slides(...), .indicators(...)(optional), .controls(...)(optional), .fade(...)(optional), .dark(...)(optional), .ride(...)(optional), .interval(...)(optional), .class(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CarouselProps.

Trait Implementations§

Source§

impl Clone for CarouselProps

Source§

fn clone(&self) -> CarouselProps

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl PartialEq for CarouselProps

Source§

fn eq(&self, other: &CarouselProps) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Properties for CarouselProps
where Self: Clone,

Source§

type Builder = CarouselPropsBuilder<((), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.
Source§

fn builder() -> Self::Builder

Create a builder for this component.
Source§

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.
Source§

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent
where M: 'static,

Create a component from the props.
Source§

impl StructuralPartialEq for CarouselProps

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,