From db98a5ac0a7a84d9642670da5a6a183fac3c5471 Mon Sep 17 00:00:00 2001 From: John Cuviello Date: Tue, 11 Jul 2023 21:43:39 -0700 Subject: [PATCH 1/6] refactored docs for 'reacting to input with state' --- .../conditional_form_component.css | 3 + .../multiple_form_components.css | 13 + .../css/managing_state/picture_component.css | 28 + .../managing_state/all_possible_states.py | 9 + .../alt_stateful_picture_component.py | 38 ++ .../managing_state/basic_form_component.py | 18 + .../conditional_form_component.py | 45 ++ .../multiple_form_components.py | 18 + .../python/managing_state/necessary_states.py | 6 + .../managing_state/picture_component.py | 16 + .../managing_state/refactored_states.py | 7 + .../managing_state/stateful_form_component.py | 69 +++ .../stateful_picture_component.py | 33 ++ .../src/learn/reacting-to-input-with-state.md | 491 +++++------------- 14 files changed, 437 insertions(+), 357 deletions(-) create mode 100644 docs/examples/css/managing_state/conditional_form_component.css create mode 100644 docs/examples/css/managing_state/multiple_form_components.css create mode 100644 docs/examples/css/managing_state/picture_component.css create mode 100644 docs/examples/python/managing_state/all_possible_states.py create mode 100644 docs/examples/python/managing_state/alt_stateful_picture_component.py create mode 100644 docs/examples/python/managing_state/basic_form_component.py create mode 100644 docs/examples/python/managing_state/conditional_form_component.py create mode 100644 docs/examples/python/managing_state/multiple_form_components.py create mode 100644 docs/examples/python/managing_state/necessary_states.py create mode 100644 docs/examples/python/managing_state/picture_component.py create mode 100644 docs/examples/python/managing_state/refactored_states.py create mode 100644 docs/examples/python/managing_state/stateful_form_component.py create mode 100644 docs/examples/python/managing_state/stateful_picture_component.py diff --git a/docs/examples/css/managing_state/conditional_form_component.css b/docs/examples/css/managing_state/conditional_form_component.css new file mode 100644 index 000000000..98c7d8768 --- /dev/null +++ b/docs/examples/css/managing_state/conditional_form_component.css @@ -0,0 +1,3 @@ +.Error { + color: red; +} \ No newline at end of file diff --git a/docs/examples/css/managing_state/multiple_form_components.css b/docs/examples/css/managing_state/multiple_form_components.css new file mode 100644 index 000000000..db8da7178 --- /dev/null +++ b/docs/examples/css/managing_state/multiple_form_components.css @@ -0,0 +1,13 @@ +section { + border-bottom: 1px solid #aaa; + padding: 20px; +} +h4 { + color: #222; +} +body { + margin: 0; +} +.Error { + color: red; +} \ No newline at end of file diff --git a/docs/examples/css/managing_state/picture_component.css b/docs/examples/css/managing_state/picture_component.css new file mode 100644 index 000000000..85827067c --- /dev/null +++ b/docs/examples/css/managing_state/picture_component.css @@ -0,0 +1,28 @@ +body { + margin: 0; + padding: 0; + height: 250px; +} + +.background { + width: 100vw; + height: 100vh; + display: flex; + justify-content: center; + align-items: center; + background: #eee; +} + +.background--active { + background: #a6b5ff; +} + +.picture { + width: 200px; + height: 200px; + border-radius: 10px; +} + +.picture--active { + border: 5px solid #a6b5ff; +} diff --git a/docs/examples/python/managing_state/all_possible_states.py b/docs/examples/python/managing_state/all_possible_states.py new file mode 100644 index 000000000..c93e7df13 --- /dev/null +++ b/docs/examples/python/managing_state/all_possible_states.py @@ -0,0 +1,9 @@ +from reactpy import hooks + + +# start +is_empty, set_is_empty = hooks.use_state(True) +is_typing, set_is_typing = hooks.use_state(False) +is_submitting, set_is_submitting = hooks.use_state(False) +is_success, set_is_success = hooks.use_state(False) +is_error, set_is_error = hooks.use_state(False) diff --git a/docs/examples/python/managing_state/alt_stateful_picture_component.py b/docs/examples/python/managing_state/alt_stateful_picture_component.py new file mode 100644 index 000000000..dfaf8f2d2 --- /dev/null +++ b/docs/examples/python/managing_state/alt_stateful_picture_component.py @@ -0,0 +1,38 @@ +from reactpy import component, event, hooks, html + + +# start +@component +def picture(): + is_active, set_is_active = hooks.use_state(False) + + if (is_active): + return html.div( + { + "class_name": "background", + "on_click": lambda event: set_is_active(False) + }, + html.img( + { + "on_click": event(stop_propagation=True), + "class_name": "picture picture--active", + "alt": "Rainbow houses in Kampung Pelangi, Indonesia", + "src": "https://i.imgur.com/5qwVYb1.jpeg" + } + ) + ) + else: + return html.div( + { + "class_name": "background background--active" + }, + html.img( + { + "on_click": event(lambda event: set_is_active(True), + stop_propagation=True), + "class_name": "picture", + "alt": "Rainbow houses in Kampung Pelangi, Indonesia", + "src": "https://i.imgur.com/5qwVYb1.jpeg" + } + ) + ) \ No newline at end of file diff --git a/docs/examples/python/managing_state/basic_form_component.py b/docs/examples/python/managing_state/basic_form_component.py new file mode 100644 index 000000000..04e57c240 --- /dev/null +++ b/docs/examples/python/managing_state/basic_form_component.py @@ -0,0 +1,18 @@ +from reactpy import component, html + + +# start +@component +def form(status="empty"): + if status == "success": + return html.h1("That's right!") + else: + return html._( + html.h2("City quiz"), + html.p("In which city is there a billboard that turns air into drinkable water?"), + html.form( + html.textarea(), + html.br(), + html.button("Submit") + ) + ) \ No newline at end of file diff --git a/docs/examples/python/managing_state/conditional_form_component.py b/docs/examples/python/managing_state/conditional_form_component.py new file mode 100644 index 000000000..0b34d38b4 --- /dev/null +++ b/docs/examples/python/managing_state/conditional_form_component.py @@ -0,0 +1,45 @@ +from reactpy import component, html + + +# start +@component +def error(status): + if status == "error": + return html.p( + {"class_name": "error"}, + "Good guess but a wrong answer. Try again!" + ) + else: + return "" + + +@component +def form(status="empty"): + # Try status="submitting", "error", "success" + if status == "success": + return html.h1("That's right!") + else: + return html._( + html.h2("City quiz"), + html.p( + "In which city is there a billboard that turns air into \ + drinkable water?" + ), + html.form( + html.textarea( + { + "disabled": "True" if status == "submitting" + else "False" + } + ), + html.br(), + html.button( + { + "disabled": True if status == "empty" + or status == "submitting" else "False" + }, + "Submit" + ), + error(status) + ) + ) \ No newline at end of file diff --git a/docs/examples/python/managing_state/multiple_form_components.py b/docs/examples/python/managing_state/multiple_form_components.py new file mode 100644 index 000000000..0648f5dd2 --- /dev/null +++ b/docs/examples/python/managing_state/multiple_form_components.py @@ -0,0 +1,18 @@ +from reactpy import component, html +from conditional_form_component import form + + +# start +@component +def item(status): + return html.section( + html.h4("Form", status, ':'), + form(status) + ) + + +@component +def app(): + statuses = ["empty", "typing", "submitting", "success", "error"] + status_list = [item(status) for status in statuses] + return html._(status_list) diff --git a/docs/examples/python/managing_state/necessary_states.py b/docs/examples/python/managing_state/necessary_states.py new file mode 100644 index 000000000..53302a251 --- /dev/null +++ b/docs/examples/python/managing_state/necessary_states.py @@ -0,0 +1,6 @@ +from reactpy import hooks + + +# start +answer, set_answer = hooks.use_state("") +error, set_error = hooks.use_state(None) diff --git a/docs/examples/python/managing_state/picture_component.py b/docs/examples/python/managing_state/picture_component.py new file mode 100644 index 000000000..9c1c5ebf8 --- /dev/null +++ b/docs/examples/python/managing_state/picture_component.py @@ -0,0 +1,16 @@ +from reactpy import component, html + + +# start +@component +def picture(): + return html.div( + {"class_name": "background background--active"}, + html.img( + { + "class_name": "picture", + "alt": "Rainbow houses in Kampung Pelangi, Indonesia", + "src": "https://i.imgur.com/5qwVYb1.jpeg" + } + ) + ) \ No newline at end of file diff --git a/docs/examples/python/managing_state/refactored_states.py b/docs/examples/python/managing_state/refactored_states.py new file mode 100644 index 000000000..1448764d4 --- /dev/null +++ b/docs/examples/python/managing_state/refactored_states.py @@ -0,0 +1,7 @@ +from reactpy import hooks + + +# start +answer, set_answer = hooks.use_state("") +error, set_error = hooks.use_state(None) +status, set_status = hooks.use_state("typing") # 'typing', 'submitting', or 'success' \ No newline at end of file diff --git a/docs/examples/python/managing_state/stateful_form_component.py b/docs/examples/python/managing_state/stateful_form_component.py new file mode 100644 index 000000000..61d732611 --- /dev/null +++ b/docs/examples/python/managing_state/stateful_form_component.py @@ -0,0 +1,69 @@ +from reactpy import component, event, html, hooks +import asyncio + + +async def submit_form(): + await asyncio.wait(5) + + +# start +@component +def error_msg(error): + if error: + return html.p( + {"class_name": "error"}, + "Good guess but a wrong answer. Try again!" + ) + else: + return "" + + +@component +def form(status="empty"): + answer, set_answer = hooks.use_state("") + error, set_error = hooks.use_state(None) + status, set_status = hooks.use_state("typing") + + @event(prevent_default=True) + async def handle_submit(event): + set_status("submitting") + try: + await submit_form(answer) + set_status("success") + except Exception: + set_status("typing") + set_error(Exception) + + @event() + def handle_textarea_change(event): + set_answer(event["target"]["value"]) + + if status == "success": + return html.h1("That's right!") + else: + return html._( + html.h2("City quiz"), + html.p( + "In which city is there a billboard \ + that turns air into drinkable water?" + ), + html.form( + {"on_submit": handle_submit}, + html.textarea( + { + "value": answer, + "on_change": handle_textarea_change, + "disabled": True if status == "submitting" else "False" + } + ), + html.br(), + html.button( + { + "disabled": True if status == "empty" + or status == "submitting" else "False" + }, + "Submit" + ), + error_msg(error) + ) + ) \ No newline at end of file diff --git a/docs/examples/python/managing_state/stateful_picture_component.py b/docs/examples/python/managing_state/stateful_picture_component.py new file mode 100644 index 000000000..6a7879535 --- /dev/null +++ b/docs/examples/python/managing_state/stateful_picture_component.py @@ -0,0 +1,33 @@ +from reactpy import component, event, hooks, html + + +# start +@component +def picture(): + is_active, set_is_active = hooks.use_state(False) + background_class_name = "background" + picture_class_name = "picture" + + if (is_active): + picture_class_name += " picture--active" + else: + background_class_name += " background--active" + + @event(stop_propagation=True) + def handle_click(event): + set_is_active(True) + + return html.div( + { + "class_name": background_class_name, + "on_click": set_is_active(False) + }, + html.img( + { + "on_click": handle_click, + "class_name": picture_class_name, + "alt": "Rainbow houses in Kampung Pelangi, Indonesia", + "src": "https://i.imgur.com/5qwVYb1.jpeg" + } + ) + ) diff --git a/docs/src/learn/reacting-to-input-with-state.md b/docs/src/learn/reacting-to-input-with-state.md index ac04c1d98..2e81aaf8f 100644 --- a/docs/src/learn/reacting-to-input-with-state.md +++ b/docs/src/learn/reacting-to-input-with-state.md @@ -141,7 +141,7 @@ You've seen how to implement a form imperatively above. To better understand how 1. **Identify** your component's different visual states 2. **Determine** what triggers those state changes -3. **Represent** the state in memory using `useState` +3. **Represent** the state in memory using `use_state` 4. **Remove** any non-essential state variables 5. **Connect** the event handlers to set the state @@ -159,69 +159,35 @@ First, you need to visualize all the different "states" of the UI the user might Just like a designer, you'll want to "mock up" or create "mocks" for the different states before you add logic. For example, here is a mock for just the visual part of the form. This mock is controlled by a prop called `status` with a default value of `'empty'`: -```js -export default function Form({ status = "empty" }) { - if (status === "success") { - return

That's right!

; - } - return ( - <> -

City quiz

-

- In which city is there a billboard that turns air into drinkable - water? -

-
- +
+ + + +
+

That's right!

+ + + ``` -```html -
-

City quiz

-

What city is located on two continents?

- -
- - - -
-

That's right!

- - -``` +=== ":material-play: Run" + + ```html + # TODO + ``` Manipulating the UI imperatively works well enough for isolated examples, but it gets exponentially more difficult to manage in more complex systems. Imagine updating a page full of different forms like this one. Adding a new UI element or a new interaction would require carefully checking all existing code to make sure you haven't introduced a bug (for example, forgetting to show or hide something). @@ -160,12 +164,14 @@ First, you need to visualize all the different "states" of the UI the user might Just like a designer, you'll want to "mock up" or create "mocks" for the different states before you add logic. For example, here is a mock for just the visual part of the form. This mock is controlled by a prop called `status` with a default value of `'empty'`: === "app.py" - ```python - {% include "../../examples/python/managing_state/basic_form_component.py" start="# start" %} + + ```python + {% include "../../examples/managing_state/basic_form_component.py" start="# start" %} ``` === ":material-play: Run" - ```python + + ```python # TODO ``` @@ -173,56 +179,55 @@ You could call that prop anything you like, the naming is not important. Try edi === "app.py" - ```python - {% include "../../examples/python/managing_state/conditional_form_component.py" start="# start" %} + ```python + {% include "../../examples/managing_state/conditional_form_component.py" start="# start" %} ``` === "styles.css" ```css - {% include "../../examples/css/managing_state/conditional_form_component.css" %} + {% include "../../examples/managing_state/conditional_form_component.css" %} ``` === ":material-play: Run" - ```python + ```python # TODO ``` - +!!! info "Deep Dive" -#### Displaying many visual states at once + **Displaying many visual states at once** -If a component has a lot of visual states, it can be convenient to show them all on one page: + ??? "Show Details" -=== "app.py" - - ```python - {% include "../../examples/python/managing_state/multiple_form_components.py" start="# start" %} - ``` + If a component has a lot of visual states, it can be convenient to show them all on one page: -=== "form.py" - - ```python - {% include "../../examples/python/managing_state/conditional_form_component.py" start="# start" %} - ``` + === "app.py" -=== "styles.css" + ```python + {% include "../../examples/managing_state/multiple_form_components.py" start="# start" %} + ``` - ```css - {% include "../../examples/css/managing_state/multiple_form_components.css" %} - ``` + === "form.py" + ```python + {% include "../../examples/managing_state/conditional_form_component.py" start="# start" %} + ``` -=== ":material-play: Run" - - ```python - # TODO - ``` + === "styles.css" -Pages like this are often called "living styleguides" or "storybooks". + ```css + {% include "../../examples/managing_state/multiple_form_components.css" %} + ``` - + === ":material-play: Run" + + ```python + # TODO + ``` + + Pages like this are often called "living styleguides" or "storybooks". ### Step 2: Determine what triggers those state changes @@ -231,23 +236,18 @@ You can trigger state updates in response to two kinds of inputs: - **Human inputs,** like clicking a button, typing in a field, navigating a link. - **Computer inputs,** like a network response arriving, a timeout completing, an image loading. - - - - + -In both cases, **you must set [state variables](/learn/state-a-components-memory#anatomy-of-usestate) to update the UI.** For the form you're developing, you will need to change state in response to a few different inputs: +In both cases, **you must set [state variables](./state-a-components-memory.md#anatomy-of-usestate) to update the UI.** For the form you're developing, you will need to change state in response to a few different inputs: - **Changing the text input** (human) should switch it from the _Empty_ state to the _Typing_ state or back, depending on whether the text box is empty or not. - **Clicking the Submit button** (human) should switch it to the _Submitting_ state. - **Successful network response** (computer) should switch it to the _Success_ state. - **Failed network response** (computer) should switch it to the _Error_ state with the matching error message. - +!!! abstract "Note" -Notice that human inputs often require [event handlers](/learn/responding-to-events)! - - + Notice that human inputs often require [event handlers](./responding-to-events.md)! To help visualize this flow, try drawing each state on paper as a labeled circle, and each change between two states as an arrow. You can sketch out many flows this way and sort out bugs long before implementation. @@ -255,37 +255,21 @@ To help visualize this flow, try drawing each state on paper as a labeled circle ### Step 3: Represent the state in memory with `useState` -Next you'll need to represent the visual states of your component in memory with [`use_state`.](/reference/react/useState) Simplicity is key: each piece of state is a "moving piece", and **you want as few "moving pieces" as possible.** More complexity leads to more bugs! +Next you'll need to represent the visual states of your component in memory with [`use_state`.](../reference/use-state.md) Simplicity is key: each piece of state is a "moving piece", and **you want as few "moving pieces" as possible.** More complexity leads to more bugs! Start with the state that _absolutely must_ be there. For example, you'll need to store the `answer` for the input, and the `error` (if it exists) to store the last error: -=== "app.py" - - ```python - {% include "../../examples/python/managing_state/necessary_states.py" start="# start" %} - ``` - -=== ":material-play: Run" - - ```python - # TODO - ``` +```python linenums="0" +{% include "../../examples/managing_state/necessary_states.py" start="# start" %} +``` Then, you'll need a state variable representing which one of the visual states that you want to display. There's usually more than a single way to represent that in memory, so you'll need to experiment with it. If you struggle to think of the best way immediately, start by adding enough state that you're _definitely_ sure that all the possible visual states are covered: -=== "app.py" - - ```python - {% include "../../examples/python/managing_state/all_possible_states.py" start="# start" %} - ``` - -=== ":material-play: Run" - - ```python - # TODO - ``` +```python linenums="0" +{% include "../../examples/managing_state/all_possible_states.py" start="# start" %} +``` Your first idea likely won't be the best, but that's ok--refactoring state is a part of the process! @@ -301,27 +285,17 @@ Here are some questions you can ask about your state variables: After this clean-up, you're left with 3 (down from 7!) _essential_ state variables: -=== "app.py" - - ```python - {% include "../../examples/python/managing_state/refactored_states.py" start="# start" %} - ``` - -=== ":material-play: Run" - - ```python - # TODO - ``` +```python linenums="0" +{% include "../../examples/managing_state/refactored_states.py" start="# start" %} +``` You know they are essential, because you can't remove any of them without breaking the functionality. - +!!! info "Deep Dive" -#### Eliminating “impossible” states with a reducer + **Eliminating “impossible” states with a reducer** -These three variables are a good enough representation of this form's state. However, there are still some intermediate states that don't fully make sense. For example, a non-null `error` doesn't make sense when `status` is `'success'`. To model the state more precisely, you can [extract it into a reducer.](/learn/extracting-state-logic-into-a-reducer) Reducers let you unify multiple state variables into a single object and consolidate all the related logic! - - + These three variables are a good enough representation of this form's state. However, there are still some intermediate states that don't fully make sense. For example, a non-null `error` doesn't make sense when `status` is `'success'`. To model the state more precisely, you can [extract it into a reducer.](./extracting-state-logic-into-a-reducer.md) Reducers let you unify multiple state variables into a single object and consolidate all the related logic! ### Step 5: Connect the event handlers to set state @@ -329,25 +303,25 @@ Lastly, create event handlers that update the state. Below is the final form, wi === "app.py" - ```python - {% include "../../examples/python/managing_state/stateful_form_component.py" start="# start" %} + ```python + {% include "../../examples/managing_state/stateful_form_component.py" start="# start" %} ``` === "styles.css" - ```css - {% include "../../examples/css/managing_state/conditional_form_component.css" %} + ```css + {% include "../../examples/managing_state/conditional_form_component.css" %} ``` === ":material-play: Run" - ```python + ```python # TODO ``` Although this code is longer than the original imperative example, it is much less fragile. Expressing all interactions as state changes lets you later introduce new visual states without breaking existing ones. It also lets you change what should be displayed in each state without changing the logic of the interaction itself. - +### Recap - Declarative programming means describing the UI for each visual state rather than micromanaging the UI (imperative). - When developing a component: @@ -357,596 +331,610 @@ Although this code is longer than the original imperative example, it is much le 4. Remove non-essential state to avoid bugs and paradoxes. 5. Connect the event handlers to set state. - - - - -#### Add and remove a CSS class +### Challenges -Make it so that clicking on the picture _removes_ the `background--active` CSS class from the outer `
`, but _adds_ the `picture--active` class to the ``. Clicking the background again should restore the original CSS classes. +=== "1. Add and remove a CSS class" -Visually, you should expect that clicking on the picture removes the purple background and highlights the picture border. Clicking outside the picture highlights the background, but removes the picture border highlight. +
-=== "picture.py" + **Challenge 1 of 3: Add and remove a CSS class** - ```python - {% include "../../examples/python/managing_state/picture_component.py" start="# start" %} - ``` - -=== "styles.css" + Make it so that clicking on the picture _removes_ the `background--active` CSS class from the outer `
`, but _adds_ the `picture--active` class to the ``. Clicking the background again should restore the original CSS classes. - ```css - {% include "../../examples/css/managing_state/picture_component.css" %} - ``` - -=== ":material-play: Run" - - ```python - # TODO - ``` + Visually, you should expect that clicking on the picture removes the purple background and highlights the picture border. Clicking outside the picture highlights the background, but removes the picture border highlight. - + === "picture.py" -This component has two visual states: when the image is active, and when the image is inactive: + ```python + {% include "../../examples/managing_state/picture_component.py" start="# start" %} + ``` -- When the image is active, the CSS classes are `background` and `picture picture--active`. -- When the image is inactive, the CSS classes are `background background--active` and `picture`. - -A single boolean state variable is enough to remember whether the image is active. The original task was to remove or add CSS classes. However, in React you need to _describe_ what you want to see rather than _manipulate_ the UI elements. So you need to calculate both CSS classes based on the current state. You also need to [stop the propagation](/learn/responding-to-events#stopping-propagation) so that clicking the image doesn't register as a click on the background. - -Verify that this version works by clicking the image and then outside of it: - -=== "app.py" - - ```python - {% include "../../examples/python/managing_state/stateful_picture_component.py" start="# start" %} - ``` - -=== "styles.css" - - ```css - {% include "../../examples/css/managing_state/picture_component.css" %} - ``` - -=== ":material-play: Run" + === "styles.css" - ```python - # TODO - ``` + ```css + {% include "../../examples/managing_state/picture_component.css" %} + ``` -Alternatively, you could return two separate chunks of PSX: + ??? "Show Solution" -=== "app.py" + This component has two visual states: when the image is active, and when the image is inactive: - ```python - {% include "../../examples/python/managing_state/stateful_picture_component.py" start="# start" %} - ``` + - When the image is active, the CSS classes are `background` and `picture picture--active`. + - When the image is inactive, the CSS classes are `background background--active` and `picture`. -=== "styles.css" + A single boolean state variable is enough to remember whether the image is active. The original task was to remove or add CSS classes. However, in React you need to _describe_ what you want to see rather than _manipulate_ the UI elements. So you need to calculate both CSS classes based on the current state. You also need to [stop the propagation](./responding-to-events.md#stopping-propagation) so that clicking the image doesn't register as a click on the background. - ```css - {% include "../../examples/css/managing_state/picture_component.css" %} - ``` + Verify that this version works by clicking the image and then outside of it: -=== ":material-play: Run" + === "app.py" - ```python - # TODO - ``` + ```python + {% include "../../examples/managing_state/stateful_picture_component.py" start="# start" %} + ``` -Keep in mind that if two different PSX chunks describe the same tree, their nesting (first `html.div` → first `html.img`) has to line up. Otherwise, toggling `is_active` would recreate the whole tree below and [reset its state.](/learn/preserving-and-resetting-state) This is why, if a similar PSX tree gets returned in both cases, it is better to write them as a single piece of PSX. - - - -#### Profile editor - -Here is a small form implemented with plain JavaScript and DOM. Play with it to understand its behavior: - -```js -function handleFormSubmit(e) { - e.preventDefault(); - if (editButton.textContent === "Edit Profile") { - editButton.textContent = "Save Profile"; - hide(firstNameText); - hide(lastNameText); - show(firstNameInput); - show(lastNameInput); - } else { - editButton.textContent = "Edit Profile"; - hide(firstNameInput); - hide(lastNameInput); - show(firstNameText); - show(lastNameText); - } -} - -function handleFirstNameChange() { - firstNameText.textContent = firstNameInput.value; - helloText.textContent = - "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; -} - -function handleLastNameChange() { - lastNameText.textContent = lastNameInput.value; - helloText.textContent = - "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; -} - -function hide(el) { - el.style.display = "none"; -} - -function show(el) { - el.style.display = ""; -} - -let form = document.getElementById("form"); -let editButton = document.getElementById("editButton"); -let firstNameInput = document.getElementById("firstNameInput"); -let firstNameText = document.getElementById("firstNameText"); -let lastNameInput = document.getElementById("lastNameInput"); -let lastNameText = document.getElementById("lastNameText"); -let helloText = document.getElementById("helloText"); -form.onsubmit = handleFormSubmit; -firstNameInput.oninput = handleFirstNameChange; -lastNameInput.oninput = handleLastNameChange; -``` + === "styles.css" -```js -{ - "hardReloadOnChange": true -} -``` + ```css + {% include "../../examples/managing_state/picture_component.css" %} + ``` -```html -
- - - -

Hello, Jane Jacobs!

-
- - -``` + === ":material-play: Run" -This form switches between two modes: in the editing mode, you see the inputs, and in the viewing mode, you only see the result. The button label changes between "Edit" and "Save" depending on the mode you're in. When you change the inputs, the welcome message at the bottom updates in real time. - -Your task is to reimplement it in React in the sandbox below. For your convenience, the markup was already converted to JSX, but you'll need to make it show and hide the inputs like the original does. - -Make sure that it updates the text at the bottom, too! - -```js -export default function EditProfile() { - return ( -
- - - -

- Hello, Jane Jacobs! -

-
- ); -} -``` + ```python + # TODO + ``` -```css -label { - display: block; - margin-bottom: 20px; -} -``` + Alternatively, you could return two separate chunks of HTML: - - -You will need two state variables to hold the input values: `firstName` and `lastName`. You're also going to need an `isEditing` state variable that holds whether to display the inputs or not. You should _not_ need a `fullName` variable because the full name can always be calculated from the `firstName` and the `lastName`. - -Finally, you should use [conditional rendering](/learn/conditional-rendering) to show or hide the inputs depending on `isEditing`. - -```js -import { useState } from "react"; - -export default function EditProfile() { - const [isEditing, setIsEditing] = useState(false); - const [firstName, setFirstName] = useState("Jane"); - const [lastName, setLastName] = useState("Jacobs"); - - return ( -
{ - e.preventDefault(); - setIsEditing(!isEditing); - }} - > - - - -

- - Hello, {firstName} {lastName}! - -

-
- ); -} -``` + === "app.py" -```css -label { - display: block; - margin-bottom: 20px; -} -``` + ```python + {% include "../../examples/managing_state/stateful_picture_component.py" start="# start" %} + ``` -Compare this solution to the original imperative code. How are they different? - -
- -#### Refactor the imperative solution without React - -Here is the original sandbox from the previous challenge, written imperatively without React: - -```js -function handleFormSubmit(e) { - e.preventDefault(); - if (editButton.textContent === "Edit Profile") { - editButton.textContent = "Save Profile"; - hide(firstNameText); - hide(lastNameText); - show(firstNameInput); - show(lastNameInput); - } else { - editButton.textContent = "Edit Profile"; - hide(firstNameInput); - hide(lastNameInput); - show(firstNameText); - show(lastNameText); - } -} - -function handleFirstNameChange() { - firstNameText.textContent = firstNameInput.value; - helloText.textContent = - "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; -} - -function handleLastNameChange() { - lastNameText.textContent = lastNameInput.value; - helloText.textContent = - "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; -} - -function hide(el) { - el.style.display = "none"; -} - -function show(el) { - el.style.display = ""; -} - -let form = document.getElementById("form"); -let editButton = document.getElementById("editButton"); -let firstNameInput = document.getElementById("firstNameInput"); -let firstNameText = document.getElementById("firstNameText"); -let lastNameInput = document.getElementById("lastNameInput"); -let lastNameText = document.getElementById("lastNameText"); -let helloText = document.getElementById("helloText"); -form.onsubmit = handleFormSubmit; -firstNameInput.oninput = handleFirstNameChange; -lastNameInput.oninput = handleLastNameChange; -``` + === "styles.css" -```js -{ - "hardReloadOnChange": true -} -``` + ```css + {% include "../../examples/managing_state/picture_component.css" %} + ``` -```html -
- - - -

Hello, Jane Jacobs!

-
- - -``` + === ":material-play: Run" -Imagine React didn't exist. Can you refactor this code in a way that makes the logic less fragile and more similar to the React version? What would it look like if the state was explicit, like in React? - -If you're struggling to think where to start, the stub below already has most of the structure in place. If you start here, fill in the missing logic in the `updateDOM` function. (Refer to the original code where needed.) - -```js -let firstName = "Jane"; -let lastName = "Jacobs"; -let isEditing = false; - -function handleFormSubmit(e) { - e.preventDefault(); - setIsEditing(!isEditing); -} - -function handleFirstNameChange(e) { - setFirstName(e.target.value); -} - -function handleLastNameChange(e) { - setLastName(e.target.value); -} - -function setFirstName(value) { - firstName = value; - updateDOM(); -} - -function setLastName(value) { - lastName = value; - updateDOM(); -} - -function setIsEditing(value) { - isEditing = value; - updateDOM(); -} - -function updateDOM() { - if (isEditing) { - editButton.textContent = "Save Profile"; - // TODO: show inputs, hide content - } else { - editButton.textContent = "Edit Profile"; - // TODO: hide inputs, show content - } - // TODO: update text labels -} - -function hide(el) { - el.style.display = "none"; -} - -function show(el) { - el.style.display = ""; -} - -let form = document.getElementById("form"); -let editButton = document.getElementById("editButton"); -let firstNameInput = document.getElementById("firstNameInput"); -let firstNameText = document.getElementById("firstNameText"); -let lastNameInput = document.getElementById("lastNameInput"); -let lastNameText = document.getElementById("lastNameText"); -let helloText = document.getElementById("helloText"); -form.onsubmit = handleFormSubmit; -firstNameInput.oninput = handleFirstNameChange; -lastNameInput.oninput = handleLastNameChange; -``` + ```python + # TODO + ``` -```js -{ - "hardReloadOnChange": true -} -``` + Keep in mind that if two different HTML chunks describe the same tree, their nesting (first `html.div` → first `html.img`) has to line up. Otherwise, toggling `is_active` would recreate the whole tree below and [reset its state.](./preserving-and-resetting-state.md) This is why, if a similar HTML tree gets returned in both cases, it is better to write them as a single piece of HTML. -```html -
- - - -

Hello, Jane Jacobs!

-
- - -``` +
- - -The missing logic included toggling the display of inputs and content, and updating the labels: - -```js -let firstName = "Jane"; -let lastName = "Jacobs"; -let isEditing = false; - -function handleFormSubmit(e) { - e.preventDefault(); - setIsEditing(!isEditing); -} - -function handleFirstNameChange(e) { - setFirstName(e.target.value); -} - -function handleLastNameChange(e) { - setLastName(e.target.value); -} - -function setFirstName(value) { - firstName = value; - updateDOM(); -} - -function setLastName(value) { - lastName = value; - updateDOM(); -} - -function setIsEditing(value) { - isEditing = value; - updateDOM(); -} - -function updateDOM() { - if (isEditing) { - editButton.textContent = "Save Profile"; - hide(firstNameText); - hide(lastNameText); - show(firstNameInput); - show(lastNameInput); - } else { - editButton.textContent = "Edit Profile"; - hide(firstNameInput); - hide(lastNameInput); - show(firstNameText); - show(lastNameText); - } - firstNameText.textContent = firstName; - lastNameText.textContent = lastName; - helloText.textContent = "Hello " + firstName + " " + lastName + "!"; -} - -function hide(el) { - el.style.display = "none"; -} - -function show(el) { - el.style.display = ""; -} - -let form = document.getElementById("form"); -let editButton = document.getElementById("editButton"); -let firstNameInput = document.getElementById("firstNameInput"); -let firstNameText = document.getElementById("firstNameText"); -let lastNameInput = document.getElementById("lastNameInput"); -let lastNameText = document.getElementById("lastNameText"); -let helloText = document.getElementById("helloText"); -form.onsubmit = handleFormSubmit; -firstNameInput.oninput = handleFirstNameChange; -lastNameInput.oninput = handleLastNameChange; -``` +=== "2. Profile editor" -```js -{ - "hardReloadOnChange": true -} -``` +
-```html -
- - - -

Hello, Jane Jacobs!

-
- - -``` + **Challenge 2 of 3: Profile editor** -The `updateDOM` function you wrote shows what React does under the hood when you set the state. (However, React also avoids touching the DOM for properties that have not changed since the last time they were set.) + Here is a small form implemented with plain JavaScript and DOM. Play with it to understand its behavior: - + === "index.js" - + ```js + function handleFormSubmit(e) { + e.preventDefault(); + if (editButton.textContent === "Edit Profile") { + editButton.textContent = "Save Profile"; + hide(firstNameText); + hide(lastNameText); + show(firstNameInput); + show(lastNameInput); + } else { + editButton.textContent = "Edit Profile"; + hide(firstNameInput); + hide(lastNameInput); + show(firstNameText); + show(lastNameText); + } + } + + function handleFirstNameChange() { + firstNameText.textContent = firstNameInput.value; + helloText.textContent = + "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; + } + + function handleLastNameChange() { + lastNameText.textContent = lastNameInput.value; + helloText.textContent = + "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; + } + + function hide(el) { + el.style.display = "none"; + } + + function show(el) { + el.style.display = ""; + } + + let form = document.getElementById("form"); + let editButton = document.getElementById("editButton"); + let firstNameInput = document.getElementById("firstNameInput"); + let firstNameText = document.getElementById("firstNameText"); + let lastNameInput = document.getElementById("lastNameInput"); + let lastNameText = document.getElementById("lastNameText"); + let helloText = document.getElementById("helloText"); + form.onsubmit = handleFormSubmit; + firstNameInput.oninput = handleFirstNameChange; + lastNameInput.oninput = handleLastNameChange; + ``` + + === "index.html" + + ```html +
+ + + +

Hello, Jane Jacobs!

+
+ + + ``` + + This form switches between two modes: in the editing mode, you see the inputs, and in the viewing mode, you only see the result. The button label changes between "Edit" and "Save" depending on the mode you're in. When you change the inputs, the welcome message at the bottom updates in real time. + + Your task is to reimplement it in React in the sandbox below. For your convenience, the markup was already converted to JSX, but you'll need to make it show and hide the inputs like the original does. + + Make sure that it updates the text at the bottom, too! + + === "app.py" + + ```js + export default function EditProfile() { + return ( +
+ + + +

+ Hello, Jane Jacobs! +

+
+ ); + } + ``` + + === "styles.css" + + ```css + label { + display: block; + margin-bottom: 20px; + } + ``` + + ??? note "Show Solution" + + You will need two state variables to hold the input values: `firstName` and `lastName`. You're also going to need an `isEditing` state variable that holds whether to display the inputs or not. You should _not_ need a `fullName` variable because the full name can always be calculated from the `firstName` and the `lastName`. + + Finally, you should use [conditional rendering](./conditional-rendering.md) to show or hide the inputs depending on `isEditing`. + + === "app.py" + + ```js + import { useState } from "react"; + + export default function EditProfile() { + const [isEditing, setIsEditing] = useState(false); + const [firstName, setFirstName] = useState("Jane"); + const [lastName, setLastName] = useState("Jacobs"); + + return ( +
{ + e.preventDefault(); + setIsEditing(!isEditing); + }} + > + + + +

+ + Hello, {firstName} {lastName}! + +

+
+ ); + } + ``` + + === "styles.css" + + ```css + label { + display: block; + margin-bottom: 20px; + } + ``` + + === ":material-play: Run" + + ```html + # TODO + ``` + + Compare this solution to the original imperative code. How are they different? + +
+ +=== "3. Refactor the imperative solution without React" + +
+ + **Challenge 3 of 3: Refactor the imperative solution without React** + + Here is the original sandbox from the previous challenge, written imperatively without React: + + === "app.py" + + ```js + function handleFormSubmit(e) { + e.preventDefault(); + if (editButton.textContent === "Edit Profile") { + editButton.textContent = "Save Profile"; + hide(firstNameText); + hide(lastNameText); + show(firstNameInput); + show(lastNameInput); + } else { + editButton.textContent = "Edit Profile"; + hide(firstNameInput); + hide(lastNameInput); + show(firstNameText); + show(lastNameText); + } + } + + function handleFirstNameChange() { + firstNameText.textContent = firstNameInput.value; + helloText.textContent = + "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; + } + + function handleLastNameChange() { + lastNameText.textContent = lastNameInput.value; + helloText.textContent = + "Hello " + firstNameInput.value + " " + lastNameInput.value + "!"; + } + + function hide(el) { + el.style.display = "none"; + } + + function show(el) { + el.style.display = ""; + } + + let form = document.getElementById("form"); + let editButton = document.getElementById("editButton"); + let firstNameInput = document.getElementById("firstNameInput"); + let firstNameText = document.getElementById("firstNameText"); + let lastNameInput = document.getElementById("lastNameInput"); + let lastNameText = document.getElementById("lastNameText"); + let helloText = document.getElementById("helloText"); + form.onsubmit = handleFormSubmit; + firstNameInput.oninput = handleFirstNameChange; + lastNameInput.oninput = handleLastNameChange; + ``` + + === "index.html" + + ```html +
+ + + +

Hello, Jane Jacobs!

+
+ + + ``` + + Imagine React didn't exist. Can you refactor this code in a way that makes the logic less fragile and more similar to the React version? What would it look like if the state was explicit, like in React? + + If you're struggling to think where to start, the stub below already has most of the structure in place. If you start here, fill in the missing logic in the `updateDOM` function. (Refer to the original code where needed.) + + === "app.py" + + ```js + let firstName = "Jane"; + let lastName = "Jacobs"; + let isEditing = false; + + function handleFormSubmit(e) { + e.preventDefault(); + setIsEditing(!isEditing); + } + + function handleFirstNameChange(e) { + setFirstName(e.target.value); + } + + function handleLastNameChange(e) { + setLastName(e.target.value); + } + + function setFirstName(value) { + firstName = value; + updateDOM(); + } + + function setLastName(value) { + lastName = value; + updateDOM(); + } + + function setIsEditing(value) { + isEditing = value; + updateDOM(); + } + + function updateDOM() { + if (isEditing) { + editButton.textContent = "Save Profile"; + // TODO: show inputs, hide content + } else { + editButton.textContent = "Edit Profile"; + // TODO: hide inputs, show content + } + // TODO: update text labels + } + + function hide(el) { + el.style.display = "none"; + } + + function show(el) { + el.style.display = ""; + } + + let form = document.getElementById("form"); + let editButton = document.getElementById("editButton"); + let firstNameInput = document.getElementById("firstNameInput"); + let firstNameText = document.getElementById("firstNameText"); + let lastNameInput = document.getElementById("lastNameInput"); + let lastNameText = document.getElementById("lastNameText"); + let helloText = document.getElementById("helloText"); + form.onsubmit = handleFormSubmit; + firstNameInput.oninput = handleFirstNameChange; + lastNameInput.oninput = handleLastNameChange; + ``` + + === "index.html" + + ```html +
+ + + +

Hello, Jane Jacobs!

+
+ + + ``` + + ??? "Show solution" + + The missing logic included toggling the display of inputs and content, and updating the labels: + + === "app.py" + + ```js + let firstName = "Jane"; + let lastName = "Jacobs"; + let isEditing = false; + + function handleFormSubmit(e) { + e.preventDefault(); + setIsEditing(!isEditing); + } + + function handleFirstNameChange(e) { + setFirstName(e.target.value); + } + + function handleLastNameChange(e) { + setLastName(e.target.value); + } + + function setFirstName(value) { + firstName = value; + updateDOM(); + } + + function setLastName(value) { + lastName = value; + updateDOM(); + } + + function setIsEditing(value) { + isEditing = value; + updateDOM(); + } + + function updateDOM() { + if (isEditing) { + editButton.textContent = "Save Profile"; + hide(firstNameText); + hide(lastNameText); + show(firstNameInput); + show(lastNameInput); + } else { + editButton.textContent = "Edit Profile"; + hide(firstNameInput); + hide(lastNameInput); + show(firstNameText); + show(lastNameText); + } + firstNameText.textContent = firstName; + lastNameText.textContent = lastName; + helloText.textContent = "Hello " + firstName + " " + lastName + "!"; + } + + function hide(el) { + el.style.display = "none"; + } + + function show(el) { + el.style.display = ""; + } + + let form = document.getElementById("form"); + let editButton = document.getElementById("editButton"); + let firstNameInput = document.getElementById("firstNameInput"); + let firstNameText = document.getElementById("firstNameText"); + let lastNameInput = document.getElementById("lastNameInput"); + let lastNameText = document.getElementById("lastNameText"); + let helloText = document.getElementById("helloText"); + form.onsubmit = handleFormSubmit; + firstNameInput.oninput = handleFirstNameChange; + lastNameInput.oninput = handleLastNameChange; + ``` + + === "index.html" + + ```html +
+ + + +

Hello, Jane Jacobs!

+
+ + + ``` + + === ":material-play: Run" + + ```html + # TODO + ``` + + The `updateDOM` function you wrote shows what React does under the hood when you set the state. (However, React also avoids touching the DOM for properties that have not changed since the last time they were set.) + +