docs: add create_resource, <Suspense/>, and <Transition/>

Cargo.toml

@@ -20,18 +20,18 @@ members = [
 exclude = ["benchmarks", "examples"]
 
 [workspace.package]
-version = "0.2.0-alpha2"
+version = "0.2.0-beta"
 
 [workspace.dependencies]
-leptos = { path = "./leptos", default-features = false, version = "0.2.0-alpha2" }
-leptos_dom = { path = "./leptos_dom", default-features = false, version = "0.2.0-alpha2" }
-leptos_macro = { path = "./leptos_macro", default-features = false, version = "0.2.0-alpha2" }
-leptos_reactive = { path = "./leptos_reactive", default-features = false, version = "0.2.0-alpha2" }
-leptos_server = { path = "./leptos_server", default-features = false, version = "0.2.0-alpha2" }
-leptos_config = { path = "./leptos_config", default-features = false, version = "0.2.0-alpha2" }
-leptos_router = { path = "./router", version = "0.2.0-alpha2" }
-leptos_meta = { path = "./meta", default-feature = false, version = "0.2.0-alpha2" }
-leptos_integration_utils = { path = "./integrations/utils", version = "0.2.0-alpha2" }
+leptos = { path = "./leptos", default-features = false, version = "0.2.0-beta" }
+leptos_dom = { path = "./leptos_dom", default-features = false, version = "0.2.0-beta" }
+leptos_macro = { path = "./leptos_macro", default-features = false, version = "0.2.0-beta" }
+leptos_reactive = { path = "./leptos_reactive", default-features = false, version = "0.2.0-beta" }
+leptos_server = { path = "./leptos_server", default-features = false, version = "0.2.0-beta" }
+leptos_config = { path = "./leptos_config", default-features = false, version = "0.2.0-beta" }
+leptos_router = { path = "./router", version = "0.2.0-beta" }
+leptos_meta = { path = "./meta", default-feature = false, version = "0.2.0-beta" }
+leptos_integration_utils = { path = "./integrations/utils", version = "0.2.0-beta" }
 
 [profile.release]
 codegen-units = 1

docs/book/src/SUMMARY.md

@@ -14,11 +14,11 @@
   - [Passing Children to Components](./view/09_component_children.md)
 - [Interlude: Reactivity and Functions](./interlude_functions.md)
 - [Testing](./testing.md)
-- [Interlude: Styling — CSS, Tailwind, Style.rs, and more]()
-- [Async]()
-  - [Resource]()
-  - [Suspense]()
+- [Async](./async/README.md)
+  - [Loading Data with Resources](./async/10_resources.md)
+  - [Suspense](./async/11_suspense.md)
   - [Transition]()
+- [Interlude: Styling — CSS, Tailwind, Style.rs, and more]()
 - [State Management]()
 - [Interlude: Advanced Reactivity]()
 - [Router]()

docs/book/src/async/10_resources.md

@@ -0,0 +1,53 @@
+# Loading Data with Resources
+
+A [Resource](https://docs.rs/leptos/latest/leptos/struct.Resource.html) is a reactive data structure that reflects the current state of an asynchronous task, allowing you to integrate asynchronous `Future`s into the synchronous reactive system. Rather than waiting for its data to load with `.await`, you transform the `Future` into a signal that returns `Some(T)` if it has resolved, and `None` if it’s still pending.
+
+You do this by using the [`create_resource`](https://docs.rs/leptos/latest/leptos/fn.create_resource.html) function. This takes two arguments (other than the ubiquitous `cx`):
+
+1. a source signal, which will generate a new `Future` whenever it changes
+2. a fetcher function, which takes the data from that signal and returns a `Future`
+
+Here’s an example
+
+```rust
+// our source signal: some synchronous, local state
+let (count, set_count) = create_signal(cx, 0);
+
+// our resource
+let async_data = create_resource(cx,
+	count,
+	// every time `count` changes, this will run
+	|value| async move {
+		log!("loading data from API");
+		load_data(value).await
+	},
+);
+```
+
+To create a resource that simply runs once, you can pass a non-reactive, empty source signal:
+
+```rust
+let once = create_resource(cx, || (), |_| async move { load_data().await });
+```
+
+To access the value you can use `.read(cx)` or `.with(cx, |data| /* */)`. These work just like `.get()` and `.with()` on a signal—`read` clones the value and returns it, `with` applies a closure to it—but with two differences
+
+1. For any `Resource<_, T>`, they always return `Option<T>`, not `T`: because it’s always possible that your resource is still loading.
+2. They take a `Scope` argument. You’ll see why in the next chapter, on `<Suspense/>`.
+
+So, you can show the current state of a resource in your view:
+
+```rust
+let once = create_resource(cx, || (), |_| async move { load_data().await });
+view! { cx,
+	<h1>"My Data"</h1>
+	{move || match once.read(cx) {
+		None => view! { cx, <p>"Loading..."</p> }.into_view(cx),
+		Some(data) => view! { cx, <ShowData data/> }.into_view(cx)
+	}}
+}
+```
+
+Resources also provide a `refetch()` method that allow you to manually reload the data (for example, in response to a button click) and a `loading()` method that returns a `ReadSignal<bool>` indicating whether the resource is currently loading or not.
+
+<iframe src="https://codesandbox.io/p/sandbox/10-async-resources-4z0qt3?file=%2Fsrc%2Fmain.rs&selection=%5B%7B%22endColumn%22%3A1%2C%22endLineNumber%22%3A3%2C%22startColumn%22%3A1%2C%22startLineNumber%22%3A3%7D%5D" width="100%" height="1000px"></iframe>

docs/book/src/async/11_suspense.md

@@ -0,0 +1,72 @@
+# `<Suspense/>`
+
+In the previous chapter, we showed how you can create a simple loading screen to show some fallback while a resource is loading.
+
+```rust
+let (count, set_count) = create_signal(cx, 0);
+let a = create_resource(cx, count, |count| async move { load_a(count).await });
+
+view! { cx,
+	<h1>"My Data"</h1>
+	{move || match once.read(cx) {
+		None => view! { cx, <p>"Loading..."</p> }.into_view(cx),
+		Some(data) => view! { cx, <ShowData data/> }.into_view(cx)
+	}}
+}
+```
+
+But what if we have two resources, and want to wait for both of them?
+
+```rust
+let (count, set_count) = create_signal(cx, 0);
+let (count2, set_count2) = create_signal(cx, 0);
+let a = create_resource(cx, count, |count| async move { load_a(count).await });
+let b = create_resource(cx, count2, |count| async move { load_b(count).await });
+
+view! { cx,
+	<h1>"My Data"</h1>
+	{move || match (a.read(cx), b.read(cx)) {
+		_ => view! { cx, <p>"Loading..."</p> }.into_view(cx),
+		(Some(a), Some(b)) => view! { cx,
+			<ShowA a/>
+			<ShowA b/>
+		}.into_view(cx)
+	}}
+}
+```
+
+That’s not _so_ bad, but it’s kind of annoying. What if we could invert the flow of control?
+
+The [`<Suspense/>`](https://docs.rs/leptos/latest/leptos/fn.Suspense.html) component lets us do exactly that. You give it a `fallback` prop and children, one or more of which usually involves reading from a resource. Reading from a resource “under” a `<Suspense/>` (i.e., in one of its children) registers that resource with the `<Suspense/>`. If it’s still waiting for resources to load, it shows the `fallback`. When they’ve all loaded, it shows the children.
+
+```rust
+let (count, set_count) = create_signal(cx, 0);
+let (count2, set_count2) = create_signal(cx, 0);
+let a = create_resource(cx, count, |count| async move { load_a(count).await });
+let b = create_resource(cx, count2, |count| async move { load_b(count).await });
+
+view! { cx,
+	<h1>"My Data"</h1>
+	<Suspense
+		fallback=move || view! { cx, <p>"Loading..."</p> }
+	>
+		<h2>"My Data"</h2>
+		<h3>"A"</h3>
+		{move || {
+			a.read(cx)
+				.map(|a| view! { cx, <ShowA a/> })
+		}}
+		<h3>"B"</h3>
+		{move || {
+			b.read(cx)
+				.map(|b| view! { cx, <ShowB b/> })
+		}}
+	</Suspense>
+}
+```
+
+Every time one of the resources is reloading, the `"Loading..."` fallback will show again.
+
+This inversion of the flow of control makes it easier to add or remove individual resources, as you don’t need to handle the matching yourself. It also unlocks some massive performance improvements during server-side rendering, which we’ll talk about during a later chapter.
+
+<iframe src="https://codesandbox.io/p/sandbox/10-async-resources-4z0qt3?file=%2Fsrc%2Fmain.rs&selection=%5B%7B%22endColumn%22%3A1%2C%22endLineNumber%22%3A3%2C%22startColumn%22%3A1%2C%22startLineNumber%22%3A3%7D%5D" width="100%" height="1000px"></iframe>

docs/book/src/async/12_transition.md

@@ -0,0 +1,9 @@
+# `<Transition/>`
+
+You’ll notice in the `<Suspense/>` example that if you keep reloading the data, it keeps flickering back to `"Loading..."`. Sometimes this is fine. For other times, there’s [`<Transition/>`](https://docs.rs/leptos/latest/leptos/fn.Suspense.html).
+
+`<Transition/>` behaves exactly the same as `<Suspense/>`, but instead of falling back every time, it only shows the fallback the first time. On all subsequent loads, it continues showing the old data until the new data are ready. This can be really handy to prevent the flickering effect, and to allow users to continue interacting with your application.
+
+This example shows how you can create a simple tabbed contact list with `<Transition/>`. When you select a new tab, it continues showing the current contact until the new data laods. This can be a much better user experience than constantly falling back to a loading message.
+
+<iframe src="https://codesandbox.io/p/sandbox/12-transition-sn38sd?selection=%5B%7B%22endColumn%22%3A15%2C%22endLineNumber%22%3A2%2C%22startColumn%22%3A15%2C%22startLineNumber%22%3A2%7D%5D&file=%2Fsrc%2Fmain.rs" width="100%" height="1000px"></iframe>

docs/book/src/async/README.md

@@ -0,0 +1,9 @@
+# Working with `async`
+
+So far we’ve only been working with synchronous users interfaces: You provide some input,
+the app immediately process it and updates the interface. This is great, but is a tiny
+subset of what web applications do. In particular, most web apps have to deal with some kind
+of asynchronous data loading, usually loading something from an API.
+
+Asynchronous data is notoriously hard to integrate with the synchronous parts of your code.
+In this chapter, we’ll see how Leptos helps smooth out that process for you.

docs/book/src/view/09_component_children.md

@@ -122,3 +122,5 @@ view! { cx,
 	</WrappedChildren>
 }
 ```
+
+<iframe src="https://codesandbox.io/p/sandbox/9-component-children-2wrdfd?file=%2Fsrc%2Fmain.rs&selection=%5B%7B%22endColumn%22%3A12%2C%22endLineNumber%22%3A19%2C%22startColumn%22%3A12%2C%22startLineNumber%22%3A19%7D%5D" width="100%" height="1000px"></iframe>

examples/parent_child/src/lib.rs

@@ -7,7 +7,8 @@ use web_sys::MouseEvent;
 //    for the child component to write into and the parent to read
 // 2) <ButtonB/>: passing a closure as one of the child component props, for
 //    the child component to call
-// 4) <ButtonC/>: providing a context that is used in the component (rather than prop drilling)
+// 3) <ButtonC/>: adding an `on:` event listener to a component
+// 4) <ButtonD/>: providing a context that is used in the component (rather than prop drilling)
 
 #[derive(Copy, Clone)]
 struct SmallcapsContext(WriteSignal<bool>);
@@ -17,6 +18,7 @@ pub fn App(cx: Scope) -> impl IntoView {
     // just some signals to toggle three classes on our <p>
     let (red, set_red) = create_signal(cx, false);
     let (right, set_right) = create_signal(cx, false);
+    let (italics, set_italics) = create_signal(cx, false);
     let (smallcaps, set_smallcaps) = create_signal(cx, false);
 
     // the newtype pattern isn't *necessary* here but is a good practice
@@ -31,6 +33,7 @@ pub fn App(cx: Scope) -> impl IntoView {
                 // class: attributes take F: Fn() => bool, and these signals all implement Fn()
                 class:red=red
                 class:right=right
+                class:italics=italics
                 class:smallcaps=smallcaps
             >
                 "Lorem ipsum sit dolor amet."
@@ -42,8 +45,13 @@ pub fn App(cx: Scope) -> impl IntoView {
             // Button B: pass a closure
             <ButtonB on_click=move |_| set_right.update(|value| *value = !*value)/>
 
+            // Button B: use a regular event listener
+            // setting an event listener on a component like this applies it
+            // to each of the top-level elements the component returns
+            <ButtonC on:click=move |_| set_italics.update(|value| *value = !*value)/>
+
             // Button D gets its setter from context rather than props
-            <ButtonC/>
+            <ButtonD/>
         </main>
     }
 }
@@ -53,7 +61,7 @@ pub fn App(cx: Scope) -> impl IntoView {
 pub fn ButtonA(
     cx: Scope,
     /// Signal that will be toggled when the button is clicked.
-    setter: WriteSignal<bool>
+    setter: WriteSignal<bool>,
 ) -> impl IntoView {
     view! {
         cx,
@@ -70,7 +78,7 @@ pub fn ButtonA(
 pub fn ButtonB<F>(
     cx: Scope,
     /// Callback that will be invoked when the button is clicked.
-    on_click: F
+    on_click: F,
 ) -> impl IntoView
 where
     F: Fn(MouseEvent) + 'static,
@@ -97,10 +105,22 @@ where
     // if Rust ever had named function arguments we could drop this requirement
 }
 
+/// Button C is a dummy: it renders a button but doesn't handle
+/// its click. Instead, the parent component adds an event listener.
+#[component]
+pub fn ButtonC(cx: Scope) -> impl IntoView {
+    view! {
+        cx,
+        <button>
+            "Toggle Italics"
+        </button>
+    }
+}
+
 /// Button D is very similar to Button A, but instead of passing the setter as a prop
 /// we get it from the context
 #[component]
-pub fn ButtonC(cx: Scope) -> impl IntoView {
+pub fn ButtonD(cx: Scope) -> impl IntoView {
     let setter = use_context::<SmallcapsContext>(cx).unwrap().0;
 
     view! {

meta/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "leptos_meta"
-version = "0.2.0-alpha2"
+version = "0.2.0-beta"
 edition = "2021"
 authors = ["Greg Johnston"]
 license = "MIT"

router/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "leptos_router"
-version = "0.2.0-alpha2"
+version = "0.2.0-beta"
 edition = "2021"
 authors = ["Greg Johnston"]
 license = "MIT"