Crate dioxus_router

Dioxus Native Core

Website | Guides | API Docs | Chat

Overview

Dioxus Router is a first-party Router for all your Dioxus Apps. It provides a React-Router style interface using somewhat loose typing rules.

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

You need to enable the right features for the platform you’re targeting since these are not determined automatically!

Contributing

• Report issues on our issue tracker.
• Join the discord and ask questions!

License

This project is licensed under the MIT license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Dioxus by you, shall be licensed as MIT, without any additional terms or conditions.

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.

RouterProps

The props for the Router component.

RouterService

An abstraction over the platform’s history API.

UseRoute

A handle to the current location of the router.

Enums

Error

An error specific to 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.

get_router_from_vdom

Get the router service from an existing VirtualDom.

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

RouterContext

A clonable handle to the router