Struct next_rs::router::NextRouter
source · pub struct NextRouter { /* private fields */ }
Expand description
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§
source§impl BaseComponent for NextRouterwhere
Self: 'static,
impl BaseComponent for NextRouterwhere
Self: 'static,
§type Properties = RouterProps
type Properties = RouterProps
The Component’s Properties.
source§fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool
fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool
Updates component’s internal state.
source§fn changed(
&mut self,
_ctx: &Context<Self>,
_old_props: &Self::Properties
) -> bool
fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties ) -> bool
React to changes of component properties.
source§fn view(&self, ctx: &Context<Self>) -> HtmlResult
fn view(&self, ctx: &Context<Self>) -> HtmlResult
Returns a component layout to be rendered.
source§fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)
fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)
Notified after a layout is rendered.
source§fn prepare_state(&self) -> Option<String>
fn prepare_state(&self) -> Option<String>
Prepares the server-side state.
source§impl Debug for NextRouter
impl Debug for NextRouter
source§impl FunctionProvider for NextRouter
impl FunctionProvider for NextRouter
§type Properties = RouterProps
type Properties = RouterProps
Properties for the Function Component.
source§fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult
fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult
Auto Trait Implementations§
impl !RefUnwindSafe for NextRouter
impl !Send for NextRouter
impl !Sync for NextRouter
impl Unpin for NextRouter
impl !UnwindSafe for NextRouter
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoPropValue<Option<T>> for T
impl<T> IntoPropValue<Option<T>> for T
source§fn into_prop_value(self) -> Option<T>
fn into_prop_value(self) -> Option<T>
Convert
self
to a value of a Properties
struct.source§impl<T> IntoPropValue<T> for T
impl<T> IntoPropValue<T> for T
source§fn into_prop_value(self) -> T
fn into_prop_value(self) -> T
Convert
self
to a value of a Properties
struct.