Skip to main content

ScrollspyProps

dioxus_bootstrap_css::scrollspy

Struct ScrollspyProps

pub struct ScrollspyProps {
    pub target: String,
    pub root: String,
    pub active: Signal<String>,
    pub offset: i32,
    pub root_margin: String,
    pub threshold: Vec<f64>,
    pub refresh_key: u64,
    pub smooth_scroll: bool,
}

Expand description

Bootstrap Scrollspy tracks scroll position and updates active section state.

The target prop follows Bootstrap semantics: it points to the nav, list group, or simple links container whose links reference section ids. Use root for the body or custom scroll container being observed.

§Bootstrap HTML -> Dioxus

HTML	Dioxus
`<body data-bs-spy="scroll" data-bs-target="#nav">`	`Scrollspy { target: "#nav", active: signal }`
`<div data-bs-spy="scroll" data-bs-target="#nav" tabindex="0">`	`Scrollspy { target: "#nav", root: "#scroll-area", active: signal }`

let active_section = use_signal(|| String::new());
rsx! {
    Scrollspy {
        target: "#docs-nav",
        root: "#docs-scroll",
        active: active_section,
        offset: 80,
    }
    nav { id: "docs-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 nav/list/simple links container.

§root: String

CSS selector for scroll container. Use "body" for viewport scroll.

§active: Signal<String>

Signal receives id currently active section.

§offset: i32

Compatibility offset in pixels for fixed or sticky headers.

§root_margin: String

IntersectionObserver root margin.

§threshold: Vec<f64>

IntersectionObserver thresholds.

§refresh_key: u64

Change this value to force section/link discovery refresh.

§smooth_scroll: bool

Smooth-scroll target links owned by target.

Implementations§

impl ScrollspyProps

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

Create a builder for building ScrollspyProps. On the builder, call .target(...)(optional), .root(...)(optional), .active(...), .offset(...)(optional), .root_margin(...)(optional), .threshold(...)(optional), .refresh_key(...)(optional), .smooth_scroll(...)(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 (const: unstable) · 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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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 !RefUnwindSafe for ScrollspyProps

impl !Send for ScrollspyProps

impl !Sync for ScrollspyProps

impl !UnwindSafe for ScrollspyProps

impl Freeze for ScrollspyProps

impl Unpin for ScrollspyProps

impl UnsafeUnpin 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> DependencyElement for T
where T: 'static + PartialEq + Clone,

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: Sized + 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: Sized + 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