Struct leptos_router::RedirectProps

pub struct RedirectProps<P>
where
    P: Display + 'static,
{
    pub path: P,
    pub options: Option<NavigateOptions>,
}

Props for the Redirect component.

Redirects the user to a new URL, whether on the client side or on the server side. If rendered on the server, this sets a 302 status code and sets a Location header. If rendered in the browser, it uses client-side navigation to redirect. In either case, it resolves the route relative to the current route. (To use an absolute path, prefix it with /).

Note: Support for server-side redirects is provided by the server framework integrations (leptos_actix and leptos_axum. If you’re not using one of those integrations, you should manually provide a way of redirecting on the server using provide_server_redirect.

Required Props

• path: [P]
  • The relative path to which the user should be redirected.

Optional Props

• options: NavigateOptions
  • Navigation options to be used on the client side.

Fields

path: P

The relative path to which the user should be redirected.

options: Option<NavigateOptions>

Navigation options to be used on the client side.

Implementations

impl<P> RedirectProps<P>

where P: Display + 'static,

pub fn builder() -> RedirectPropsBuilder<P, ((), ())>

Create a builder for building RedirectProps. On the builder, call .path(...), .options(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RedirectProps.

Trait Implementations

impl<P> IntoView for RedirectProps<P>

where P: Display + 'static,

fn into_view(self) -> View

Converts the value into View.