Skip to main content

ScrollspyProps

dioxus_bootstrap_css::scrollspy

Struct ScrollspyProps

pub struct ScrollspyProps {
    pub target: String,
    pub active: Signal<String>,
    pub offset: i32,
}

Expand description

Bootstrap Scrollspy — tracks scroll position and updates active signal.

Place this component in your layout. It watches the given target element (by CSS selector) and updates the active signal with the id of the currently visible section.

§Bootstrap HTML → Dioxus

HTML	Dioxus
`<body data-bs-spy="scroll" data-bs-target="#nav" data-bs-offset="80">`	`Scrollspy { target: "body", active: signal, offset: 80 }`
Check active section via JS	`if *active.read() == "intro" { "active" }`

let active_section = use_signal(|| String::new());
rsx! {
    Scrollspy { target: "main", active: active_section, offset: 80 }
    nav {
        a { class: if *active_section.read() == "intro" { "nav-link active" } else { "nav-link" },
            href: "#intro", "Intro" }
        a { class: if *active_section.read() == "features" { "nav-link active" } else { "nav-link" },
            href: "#features", "Features" }
    }
}

Fields§

§target: String

CSS selector for the scrollable container (e.g., “main”, “#content”, “body”).

§active: Signal<String>

Signal that receives the id of the currently active section.

§offset: i32

Offset in pixels from the top (useful for fixed/sticky navbars).

Implementations§

impl ScrollspyProps

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

Create a builder for building ScrollspyProps. On the builder, call .target(...)(optional), .active(...), .offset(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ScrollspyProps.

Trait Implementations§

impl Clone for ScrollspyProps

fn clone(&self) -> ScrollspyProps

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

impl PartialEq for ScrollspyProps

fn eq(&self, other: &ScrollspyProps) -> 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.

impl Properties for ScrollspyProps
where Self: Clone,

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

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

fn builder() -> Self::Builder

Create a builder for this component.

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.

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

Create a component from the props.

impl StructuralPartialEq for ScrollspyProps

Auto Trait Implementations§

impl Freeze for ScrollspyProps

impl !RefUnwindSafe for ScrollspyProps

impl !Send for ScrollspyProps

impl !Sync for ScrollspyProps

impl Unpin for ScrollspyProps

impl UnsafeUnpin for ScrollspyProps

impl !UnwindSafe for ScrollspyProps

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

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