Evan AlmloffandJonathan Kelley
519ec9d294
* add a default head method through eval * remove the old document trait * implement document for each platform * pull out document into a dedicated crate to cut down on shared dependencies --------- Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
60 lines
2.1 KiB
Markdown
60 lines
2.1 KiB
Markdown
# Modifying the Head
|
|
|
|
Dioxus includes a series of components that render into the head of the page:
|
|
|
|
- [Title](crate::Title)
|
|
- [Meta](crate::Meta)
|
|
- [document::Link](crate::document::Link)
|
|
- [Script](crate::Script)
|
|
- [Style](crate::Style)
|
|
|
|
Each of these components can be used to add extra information to the head of the page. For example, you can use the `Title` component to set the title of the page, or the `Meta` component to add extra metadata to the page.
|
|
|
|
## Limitations
|
|
|
|
Components that render into the head of the page do have a few key limitations:
|
|
|
|
- With the exception of the `Title` component, all components that render into the head cannot be modified after the first time they are rendered.
|
|
- Components that render into the head will not be removed even after the component is removed from the tree.
|
|
|
|
## Example
|
|
|
|
```rust, no_run
|
|
# use dioxus::prelude::*;
|
|
fn RedirectToDioxusHomepageWithoutJS() -> Element {
|
|
rsx! {
|
|
// You can use the meta component to render a meta tag into the head of the page
|
|
// This meta tag will redirect the user to the dioxuslabs homepage in 10 seconds
|
|
document::Meta {
|
|
http_equiv: "refresh",
|
|
content: "10;url=https://dioxuslabs.com",
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Fullstack Rendering
|
|
|
|
Head components are compatible with fullstack rendering, but only head components that are rendered in the initial render (before suspense boundaries resolve) will be rendered into the head.
|
|
|
|
If you have any important metadata that you want to render into the head, make sure to render it outside of any pending suspense boundaries.
|
|
|
|
```rust, no_run
|
|
# use dioxus::prelude::*;
|
|
# #[component]
|
|
# fn LoadData(children: Element) -> Element { unimplemented!() }
|
|
fn App() -> Element {
|
|
rsx! {
|
|
// This will render in SSR
|
|
document::Title { "My Page" }
|
|
SuspenseBoundary {
|
|
fallback: |_| rsx! { "Loading..." },
|
|
LoadData {
|
|
// This will only be rendered on the client after hydration so it may not be visible to search engines
|
|
document::Meta { name: "description", content: "My Page" }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|