Struct NavLink 

pub struct NavLink<R: Routable + PartialEq + Clone + 'static> { /* private fields */ }

Navigation link with automatic active state detection.

Wraps Yew Router’s Link component and automatically applies the active CSS class when the target route matches the current URL.

CSS Classes

• nav-link - Always applied
• active - Applied when route matches current URL

Type Parameters

• R - Route type implementing Routable

Example

use yew::prelude::*;
use yew_nav_link::NavLink;
use yew_router::prelude::*;

#[derive(Clone, PartialEq, Routable)]
enum Route {
    #[at("/")]
    Home,
    #[at("/about")]
    About
}

#[component]
fn Navigation() -> Html {
    html! {
        <nav>
            <NavLink<Route> to={Route::Home}>{ "Home" }</NavLink<Route>>
            <NavLink<Route> to={Route::About}>{ "About" }</NavLink<Route>>
        </nav>
    }
}

Trait Implementations

impl<R> BaseComponent for NavLink<R>

where R: 'static + Routable + PartialEq + Clone, Self: 'static,

type Message = ()

The Component’s Message.

type Properties = NavLinkProps<R>

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl<R: Routable + PartialEq + Clone + 'static> Debug for NavLink<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Routable + PartialEq + Clone + 'static> FunctionProvider for NavLink<R>

type Properties = NavLinkProps<R>

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.