Struct NavLinkProps 

pub struct NavLinkProps {
    pub href: String,
    pub active: bool,
    pub disabled: bool,
    pub prevent_default: bool,
    pub onclick: Option<EventHandler<MouseEvent>>,
    pub class: String,
    pub children: Element,
    /* private fields */
}

Bootstrap NavLink component.

Bootstrap HTML → Dioxus

HTML	Dioxus
<a class="nav-link active" href="/">Home</a>	NavLink { href: "/", active: true, "Home" }
<a class="nav-link disabled" aria-disabled="true" tabindex="-1">Disabled</a>	NavLink { disabled: true, "Disabled" }

For single-page apps that switch content client-side, set prevent_default: true so a click on a #-href link runs only your onclick handler and does not follow the anchor (no hash change, no scroll-to-top). For a JS-toggled tab button (<button class="nav-link">) use NavButton instead of an anchor.

rsx! {
    NavLink { href: "/dashboard", active: true, "Dashboard" }
    // SPA tab link: handler runs, page does not navigate.
    NavLink { prevent_default: true, onclick: move |_| { /* switch section */ }, "Settings" }
}

Fields

href: String

Link href.

active: bool

Active state.

disabled: bool

Disabled state.

prevent_default: bool

Call event.prevent_default() on click so the anchor is not followed (SPA-safe: the onclick handler runs, but the URL/hash is untouched and the page does not scroll to top). Matches what Bootstrap’s own JS does for #-href toggle links.

onclick: Option<EventHandler<MouseEvent>>

Click event handler.

class: String

Additional CSS classes.

children: Element

Child elements.

Implementations

impl NavLinkProps

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

Create a builder for building NavLinkProps. On the builder, call .href(...)(optional), .active(...)(optional), .disabled(...)(optional), .prevent_default(...)(optional), .onclick(...)(optional), .class(...)(optional), .attributes(...)(optional), .children(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of NavLinkProps.

Trait Implementations

impl Clone for NavLinkProps

fn clone(&self) -> NavLinkProps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for NavLinkProps

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

Equality operator ==.

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

Inequality operator !=.

impl Properties for NavLinkProps

where Self: Clone,

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

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 NavLinkProps