Skip to content
This repository has been archived by the owner on Jul 19, 2020. It is now read-only.

3/8 add trap events page #84

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions src/concepts/components/trapevents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
description: Component could mutate internal state or re-render based on events emitted by html or Yew components
---

# Listen to events and mutate state

The framework provide the capability to update the internal state, for example, when an event is emitted by a child component.

The `update` method could be called and mutate the internal state. The `update` method is called via `self.link.callback`, `link` being an attribute of the component struct.

The `update` method receives "context" by the argument `msg` of type `Self::Message`. You can define any type for `Message`. The common way is to define an enum `Msg` for any action that can mutate the state. Then define `Msg` as the type of `Message` in the Component trait implementation.

You can decide to render the component returning `true` from the `Update` method.

```rust
use yew::prelude::*;

pub struct ListenEventComponent {
link: ComponentLink<Self>,
name: String,
show_message: bool,
}

pub enum Msg {
Click,
}

impl Component for ListenEventComponent {
type Message = Msg;
type Properties = ();

fn create(_props: Self::Properties, link: ComponentLink<Self>) -> Self {
Self {
link,
name: "Clark".into(),
show_message: false,
}
}

fn update(&mut self, msg: Self::Message) -> ShouldRender {
match msg {
Msg::Click => self.show_message = true,
}
true
}

fn change(&mut self, _props: Self::Properties) -> ShouldRender {
true
}

fn view(&self) -> Html {
if !self.show_message {
html! {
<>
<button onclick=self.link.callback( |_| Msg::Click )>{"Click here!"}</button>
</>
}
} else {
html! {
<>
<h1>{format!("Hello {}", self.name)}</h1>
</>
}
}
}
}

```

## Define the `link` attribute in the state

```rust
// ...
pub struct ListenEventComponent {
link: ComponentLink<Self>,
// ...
```

## Define a Message enum

```rust

// ...
pub enum Msg {
Click,
}

impl Component for ListenEventComponent {
type Message = Msg;
type Properties = ();

// ...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment should be indented in line with the code after.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure. This is a "documentation information" it's not a code comment.
It's just to hihghlight this is a piece of code ... there is something after.

I had to do in this way due to the automatic tests.

Temporarly I remove the automatic tests. For more readability, I test the example in a dedicated project https://github.com/rlasjunies/yew-doc-examples

I will add again the tests if it's really required.

```

## Update the internal state based on the context

```rust
// ...
fn update(&mut self, msg: Self::Message) -> ShouldRender {
match msg {
Msg::Click => self.show_message = true,
}
true
}
// ...
```

## Register to the html events

```rust

// ...
html! {
<button onclick=self.link.callback( |_| Msg::Click)>{"Click here!"}</button>
// ...
```