Struct NavList 

pub struct NavList<S> { /* private fields */ }

A list of links to the sections of an application, marking the one the page is in.

It is a <nav> named by its label, holding a list of links. The page passes its own Url, which the server writes with Route::url, and each link is compared with it by path, without the query string. A link to the page’s path has aria-current="page". A link to a path that the page’s path continues, such as /users on the page /users/7, has aria-current="true", so the section stays marked on the pages under it.

use hypersig::{Page, Route, Signals};
use hypersig_ui::NavList;
use serde::{Deserialize, Serialize};

#[derive(Signals, Serialize, Deserialize)]
struct Admin {
    name: String,
}

hypersig::routes! {
    fn pages(Router<()>);
    const HOME: Route = "/" => page;
    const USERS: Route = "/users" => page;
    const USER: Route<i32> = "/users/{id}" => page;
}

let sidebar = NavList::<Admin>::new("Main", USER.url(7))
    .item("Dashboard", HOME, ())
    .item("Users", USERS, ())
    .render();
let html = sidebar.render();
assert!(html.contains(r#"href="/users" aria-current="true""#));

Implementations

impl<S> NavList<S>

pub fn new(label: impl Into<String>, current: Url) -> Self

An empty list whose <nav> is named label, on the page at current.

pub fn item<P: Params, Q: Search>( self, text: impl Into<String>, route: Route<P, Q>, args: Q::Args<P>, ) -> Self

where Q::Args<P>: Serialize,

Adds a link to route with the arguments args, as Route::url takes them.

pub fn render(self) -> El<S>

The <nav> and its list.

Trait Implementations

impl<S: Debug> Debug for NavList<S>

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

Formats the value using the given formatter.

impl<S> From<NavList<S>> for El<S>

fn from(list: NavList<S>) -> Self

Converts to this type from the input type.

impl<S> From<NavList<S>> for Node<S>

fn from(list: NavList<S>) -> Self

Converts to this type from the input type.