Skip to main content

CarouselContext

dioxus_ui_system::organisms::carousel

Struct CarouselContext

pub struct CarouselContext {
    pub current_index: Signal<usize>,
    pub total_items: Signal<usize>,
    pub options: CarouselOptions,
    pub orientation: Orientation,
    pub go_next: Callback<()>,
    pub go_prev: Callback<()>,
    pub go_to: Callback<usize>,
    pub can_go_prev: Memo<bool>,
    pub can_go_next: Memo<bool>,
    pub is_paused: Signal<bool>,
}

Expand description

Shared carousel context for compound components

Fields§

§current_index: Signal<usize>

Current active index signal

§total_items: Signal<usize>

Total number of items signal

§options: CarouselOptions

Carousel options

§orientation: Orientation

Orientation

§go_next: Callback<()>

Go to next slide callback

§go_prev: Callback<()>

Go to previous slide callback

§go_to: Callback<usize>

Go to specific index callback

§can_go_prev: Memo<bool>

Whether currently at first slide (memoized)

§can_go_next: Memo<bool>

Whether currently at last slide (memoized)

§is_paused: Signal<bool>

Whether autoplay is paused

Trait Implementations§

impl Clone for CarouselContext

fn clone(&self) -> CarouselContext

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

Auto Trait Implementations§

impl Freeze for CarouselContext

impl !RefUnwindSafe for CarouselContext

impl !Send for CarouselContext

impl !Sync for CarouselContext

impl Unpin for CarouselContext

impl UnsafeUnpin for CarouselContext

impl !UnwindSafe for CarouselContext

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> InitializeFromFunction<T> for T

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

Create an instance of this type from an initialization function

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn spawn(self) -> Ret

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

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

fn super_from(input: T) -> O

Convert from a type to another type.

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

fn super_into(self) -> O

Convert from a type to another type.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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