Improve inline docs (#2460)

Improve inline docs

* improve incorrect event handler return error message

* Improve event handler docs

* document the eval functions

* document spawn and common spawn errors

* fix event handler docs

* add notes about how you use attributes and elements in rsx

* add doc aliases for attributes and events we rename

* add some more aliases for common search terms

* don't doc ignore any public examples in core

* don't ignore public doc examples in ssr

* don't ignore examples in the dioxus package readme

* add a warning when you launch without a renderer enabled

* fix some outdated element docs

* add a bunch of examples to resource

* add notes about desktop events

* add more docs for use_resource

* add on_unimplemented hint to Dependency

* fix some unresolved links

* add examples to each of the router traits

* add not implemented errors for router traits

* add an example to the routable trait

* expand rsx macro docs

* improve memo docs

* update the dioxus readme

* mention dioxus crate features in the docs

* fix a bunch of doc tests

* fix html doc tests

* fix router doc tests

* fix dioxus signals doc tests

* fix dioxus ssr doc tests

* fix use_future example in the hooks cheat sheet

* add a javascript alias for eval

* fix hook explanation values

* remove unused embed-doc-image dependency
This commit is contained in:
Evan Almloff authored and GitHub committed 2024-06-06 18:15:17 -07:00
1 parent 054351139f
commit 0127501dbf
71 files changed
+4132 -1162

No files matched your search

Generated
+11
View File
@@ -2077,6 +2077,7 @@ name = "dioxus"
version = "0.5.2"
dependencies = [
"criterion 0.3.6",
"dioxus",
"dioxus-config-macro",
"dioxus-core 0.5.2",
"dioxus-core-macro",
@@ -2249,12 +2250,14 @@ dependencies = [
"rand 0.8.5",
"reqwest",
"rustc-hash",
"rustversion",
"serde",
"slab",
"tokio",
"tracing",
"tracing-fluent-assertions",
"tracing-subscriber",
"web-sys",
]
[[package]]
@@ -2403,6 +2406,8 @@ dependencies = [
"futures-channel",
"futures-util",
"generational-box 0.5.2",
"reqwest",
"rustversion",
"slab",
"thiserror",
"tokio",
@@ -2437,15 +2442,18 @@ name = "dioxus-html"
version = "0.5.2"
dependencies = [
"async-trait",
"dioxus",
"dioxus-core 0.5.2",
"dioxus-html-internal-macro",
"dioxus-rsx",
"dioxus-web",
"enumset",
"euclid",
"futures-channel",
"generational-box 0.5.2",
"keyboard-types",
"rfd",
"rustversion",
"serde",
"serde-value",
"serde_json",
@@ -2590,6 +2598,7 @@ dependencies = [
"gloo-utils 0.1.7",
"http 1.1.0",
"js-sys",
"rustversion",
"serde",
"serde_json",
"tokio",
@@ -2638,6 +2647,8 @@ dependencies = [
"generational-box 0.5.2",
"once_cell",
"parking_lot",
"rand 0.8.5",
"reqwest",
"rustc-hash",
"serde",
"simple_logger",