Update Router book to reflect crate separation and need for web feature. (#873)
This commit is contained in:
1 parent
79074a0a7c
commit
eee6cbabb2
2 files changed
+7
-6
No files matched your search
@@ -1,10 +1,11 @@
|
||||
# Dioxus Router: Introduction
|
||||
|
||||
Whether or not you're building a website, desktop app, or mobile app, organizing your app's views into "pages" can be an effective method for organization and maintainability.
|
||||
|
||||
Dioxus comes with a router built-in. To start utilizing Dioxus Router, enable the ``router`` feature in your ``Cargo.toml`` file.
|
||||
```toml
|
||||
[dependencies]
|
||||
dioxus = { version = "x.x.x", features = [.., "router"] }
|
||||
```
|
||||
The `dioxus-router` crate contains the Router module. To add it to your project run:
|
||||
|
||||
cargo add dioxus-router
|
||||
|
||||
> **Be sure to include the `web` feature (`--feature web`) for deployment into a browser!**
|
||||
|
||||
In this book you'll find a short [guide](./guide/index.md) to get up to speed with Dioxus Router, as well as the router's [reference](./reference/index.md).
|
||||
@@ -1,4 +1,4 @@
|
||||
# Dioxus Native Core
|
||||
# Dioxus Router
|
||||
|
||||
[![Crates.io][crates-badge]][crates-url]
|
||||
[![MIT licensed][mit-badge]][mit-url]
|
||||
|
||||
Reference in new issue
Block a user