Struct NextRouter

pub struct NextRouter { /* private fields */ }

The NextRouter component.

This component provides location and navigator context to its children and switches.

If you are building a web application, you may want to consider using [BrowserRouter] instead.

You only need one <Router /> for each application.

Arguments

• props - The properties of the router.

Returns

(Html): An HTML representation of the router component.

Example

use next_rs::prelude::*;
use next_rs::router::*;
use next_rs::history::{BrowserHistory, AnyHistory};

#[func]
fn MyComponent() -> Html {
    rsx! {
        <NextRouter basename="" history={AnyHistory::Browser(BrowserHistory::new())}>
            <div />
        </NextRouter>
    }
}

Trait Implementations

impl BaseComponent for NextRouter

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = RouterProps

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 Debug for NextRouter

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

Formats the value using the given formatter.

impl FunctionProvider for NextRouter

type Properties = RouterProps

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.