Crate dioxus_router

Dioxus Router

Website | Examples | Guide (0.1.8) | Guide (Master)

Dioxus Router is a first-party Router for all your Dioxus Apps. It provides a React-Router style interface that works anywhere: across the browser, SSR, and natively.

fn app() {
    cx.render(rsx! {
        Router {
            Route { to: "/", Component {} },
            Route { to: "/blog", Blog {} },
            Route { to: "/blog/:id", BlogPost {} },
        }
    })
}

Resources

• See the mdbook
• See the one-page brief
• See the guide on the doc site
• The crates.io API

Structs

LinkProps

Props for the Link component.

ParsedRoute

A route is a combination of window title, saved state, and a URL.

RedirectProps

The props for the Router component.

RouteContext

A RouteContext is a context that is provided by Route components.

RouteProps

Props for the Route component.

RouterCore

An abstraction over the platform’s history API.

RouterProps

The props for the Router component.

UseRoute

A handle to the current location of the router.

Functions

Link

A component that renders a link to a route.

Redirect

If this component is rendered, it will redirect the user to the given route.

Route

A component that conditionally renders children based on the current location.

Router

A component that conditionally renders children based on the current location of the app.

use_route

This hook provides access to information about the current location in the context of a [Router]. If this function is called outside of a Router component it will panic.

use_router

This hook provides access to the RouterService for the app.

Type Definitions

RouterService

A shared type for the RouterCore.