Skip to main content

Nav

Struct Nav 

Source
pub struct Nav { /* private fields */ }
Expand description

Builder for <nav> elements.

Represents a navigation section containing links to other pages or sections within the page.

§Examples

use html_generator::elements::{Nav, SemanticElement};

let html = Nav::new()
    .aria_label("Primary")
    .child(r#"<a href="/">Home</a>"#)
    .build();
assert!(html.contains("<nav"));
assert!(html.contains(r#"aria-label="Primary""#));

Implementations§

Source§

impl Nav

Source

pub fn new() -> Self

Creates a new builder with default values.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().build();
assert!(html.contains("<article"));
Source

pub fn id(self, id: &str) -> Self

Sets the id attribute.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().id("post-1").build();
assert!(html.contains(r#"id="post-1""#));
Source

pub fn class(self, class: &str) -> Self

Sets the class attribute.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().class("post").build();
assert!(html.contains(r#"class="post""#));
Source

pub fn aria_label(self, label: &str) -> Self

Sets the aria-label attribute.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().aria_label("Latest post").build();
assert!(html.contains(r#"aria-label="Latest post""#));
Source

pub fn aria_labelledby(self, id: &str) -> Self

Sets the aria-labelledby attribute.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().aria_labelledby("title-1").build();
assert!(html.contains(r#"aria-labelledby="title-1""#));
Source

pub fn attr(self, key: &str, value: &str) -> Self

Adds a custom attribute.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().attr("data-id", "42").build();
assert!(html.contains(r#"data-id="42""#));
Source

pub fn child(self, html: &str) -> Self

Appends child HTML content.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().child("<p>Body</p>").build();
assert!(html.contains("<p>Body</p>"));
Source

pub fn children(self, items: &[&str]) -> Self

Appends multiple child HTML content strings.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new()
    .children(&["<h1>T</h1>", "<p>B</p>"])
    .build();
assert!(html.contains("<h1>T</h1><p>B</p>"));
Source

pub fn build(&self) -> String

Renders the element to an HTML string.

§Examples
use html_generator::elements::{Article, SemanticElement};

let html = Article::new().id("a").build();
assert!(html.starts_with("<article"));
assert!(html.ends_with("</article>"));

Trait Implementations§

Source§

impl Clone for Nav

Source§

fn clone(&self) -> Nav

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
Source§

impl Debug for Nav

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Nav

Source§

fn default() -> Nav

Returns the “default value” for a type. Read more
Source§

impl SemanticElement for Nav

Source§

fn build(&self) -> String

Render the element to an HTML string. Read more

Auto Trait Implementations§

§

impl Freeze for Nav

§

impl RefUnwindSafe for Nav

§

impl Send for Nav

§

impl Sync for Nav

§

impl Unpin for Nav

§

impl UnsafeUnpin for Nav

§

impl UnwindSafe for Nav

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

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
Source§

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