Struct RouterContext

pub struct RouterContext<T>
where
    T: Target,
{
    pub active_target: Option<T>,
    /* private fields */
}

Fields

active_target: Option<T>

Implementations

impl<T> RouterContext<T>

where T: Target,

pub fn push(&self, target: T)

Push a new state to the history. This changes the current page, but doesn’t actually leave the page.

pub fn replace(&self, target: T)

Replace current state on the history. This changes the current page, but doesn’t actually leave the page.

pub fn push_with(&self, target: T, state: State)

Push a new state to the history, allow setting page state at the same time.

pub fn replace_with(&self, target: T, state: State)

Replace current state on the history, allow setting page state at the same time.

pub fn render_target(&self, target: T) -> String

Render the path of target.

This includes the parenting scopes as well as the “base” URL of the document.

pub fn render_target_with( &self, target: T, state: impl IntoPropValue<State>, ) -> String

Render the path of target.

This includes the parenting scopes as well as the “base” URL of the document. It also adds the state using the hash.

pub fn is_same(&self, target: &T) -> bool

Check if the provided target is the active target

pub fn is_active( &self, target: &T, predicate: Option<&Callback<T, bool>>, ) -> bool

Check if the target is active.

This is intended for components to find out if their target, or part of their target is active. If the function is provided with a predicate, then this will override the decision process. Otherwise function will check if the provided target is the same as the active target.

Assume you have a nested navigation tree. The active state of a leaf entry would be identified by the target being “the same”. While branch entries would need to provide a predicate, as there is no “value” to compare to.

A component supporting this model can provide two properties: a target, and an optional predicate. The user can then configure this accordingly. The component can simply pass the information to this function to perform the check.

pub fn active(&self) -> &Option<T>

Get the active target, this may be None, in the case this branch doesn’t have an active target.

Trait Implementations

impl<T> Clone for RouterContext<T>

where T: Target + Clone,

fn clone(&self) -> RouterContext<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> PartialEq for RouterContext<T>

where T: Target + PartialEq,

fn eq(&self, other: &RouterContext<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StructuralPartialEq for RouterContext<T>

where T: Target,