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

+21 -13
View File
@@ -153,13 +153,15 @@ impl ErrorBoundary {
///
/// The call stack is saved for this component and provided to the error boundary
///
/// ```rust, ignore
/// ```rust
/// use dioxus::prelude::*;
///
/// #[component]
/// fn app(count: String) -> Element {
/// let id: i32 = count.parse().throw()?;
/// let count: i32 = count.parse().throw()?;
///
/// rsx! {
/// div { "Count {}" }
/// div { "Count {count}" }
/// }
/// }
/// ```
@@ -178,13 +180,15 @@ pub trait Throw<S = ()>: Sized {
/// which is what this trait shells out to.
///
///
/// ```rust, ignore
/// ```rust
/// use dioxus::prelude::*;
///
/// #[component]
/// fn app( count: String) -> Element {
/// let id: i32 = count.parse().throw()?;
/// let count: i32 = count.parse().throw()?;
///
/// rsx! {
/// div { "Count {}" }
/// div { "Count {count}" }
/// }
/// }
/// ```
@@ -201,13 +205,15 @@ pub trait Throw<S = ()>: Sized {
/// which is what this trait shells out to.
///
///
/// ```rust, ignore
/// ```rust
/// use dioxus::prelude::*;
///
/// #[component]
/// fn app( count: String) -> Element {
/// let id: i32 = count.parse().throw()?;
/// let count: i32 = count.parse().throw()?;
///
/// rsx! {
/// div { "Count {}" }
/// div { "Count {count}" }
/// }
/// }
/// ```
@@ -447,13 +453,15 @@ impl<
///
/// ## Example
///
/// ```rust, ignore
/// rsx!{
/// ```rust
/// # use dioxus::prelude::*;
/// # fn ThrowsError() -> Element { todo!() }
/// rsx! {
/// ErrorBoundary {
/// handle_error: |error| rsx! { "Oops, we encountered an error. Please report {error} to the developer of this application" }
/// handle_error: |error| rsx! { "Oops, we encountered an error. Please report {error} to the developer of this application" },
/// ThrowsError {}
/// }
/// }
/// };
/// ```
///
/// ## Usage