Skip to content

Commit

Permalink
feat: Add head ordering doc part
Browse files Browse the repository at this point in the history
  • Loading branch information
mcmah309 committed Feb 20, 2025
1 parent bdeedc1 commit 5737bcb
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions packages/document/docs/head.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ 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.
- Components that render into the head do not have a guaranteed ordering; thus, components should ideally not be order dependent, since they may not appear in the head in the order they are defined.

## Example

Expand All @@ -33,6 +34,36 @@ fn RedirectToDioxusHomepageWithoutJS() -> Element {
}
```

## Overcoming Ordering Issues

Since Dioxus does not guarantee head element ordering, one can use es6 imports as a more predictable way to handle dependencies.

```rust
# use dioxus::prelude::*;
static HIGHLIGHT: Asset = asset!("/assets/highlight/es/highlight.min.js");
static RUST: Asset = asset!("/assets/highlight/es/languages/rust.min.js");
static STYLE: Asset = asset!("/assets/highlight/styles/atom-one-dark.css");

fn App() -> Element {
rsx! {
document::Link { rel: "stylesheet", href: STYLE }
document::Script {
type: "module",
r#"import hljs from "{HIGHLIGHT}";
import rust from "{RUST}";
hljs.registerLanguage('rust', rust);
hljs.highlightAll();"#
}
pre {
code {
class: "language-rust",
"fn main() {{\nprintln!(\"Hello, world!\");\n}}"
}
}
}
}
```

## 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.
Expand Down

0 comments on commit 5737bcb

Please sign in to comment.