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

+12 -13
View File
@@ -11,10 +11,12 @@ use crate::innerlude::*;
///
/// ## Example
///
/// ```rust, ignore
/// ```rust
/// # use dioxus::prelude::*;
/// let value = 1;
/// rsx!{
/// Fragment { key: "abc" }
/// }
/// Fragment { key: "{value}" }
/// };
/// ```
///
/// ## Usage
@@ -61,28 +63,25 @@ impl<const A: bool> FragmentBuilder<A> {
///
/// ## Example
///
/// ```rust, ignore
/// ```rust
/// # use dioxus::prelude::*;
/// fn app() -> Element {
/// rsx!{
/// CustomCard {
/// h1 {}
/// p {}
/// }
/// })
/// }
/// }
///
/// #[derive(PartialEq, Props)]
/// struct CardProps {
/// children: Element
/// }
///
/// fn CustomCard(cx: CardProps) -> Element {
/// #[component]
/// fn CustomCard(children: Element) -> Element {
/// rsx!{
/// div {
/// h1 {"Title card"}
/// {cx.children}
/// {children}
/// }
/// })
/// }
/// }
/// ```
impl Properties for FragmentProps {