Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for contexts #1847

Merged
merged 1 commit into from
May 11, 2021
Merged
Show file tree
Hide file tree
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
77 changes: 77 additions & 0 deletions docs/concepts/contexts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: Contexts
sidebar_label: Contexts
description: Using contexts to pass data within application
---

Generally data is passed down the component tree using props but that becomes tedious for values such as
user preferences, authentication information etc. Consider the following example which passes down the
theme using props:
```rust
// root
let theme = // ...
html! {
<Navbar theme=theme />
}

// Navbar component
html! {
<div>
<Title theme=theme>{ "App title" }<Title>
<NavButton theme=theme>{ "Somewhere" }</NavButton>
</div>
}
```

Passing down data like this isn't ideal for something like a theme which needs to be available everywhere.
This is where contexts come in.

Contexts provide a way to share data between components without passing them down explicitly as props.
They make data available to all components in the tree.

## Using Contexts

In order to use contexts, we need a struct which defines what data is to be passed.
For the above use-case, consider the following struct:
```rust
#[derive(Clone, Debug, PartialEq)]
struct Theme {
foreground: String,
background: String,
}
```

A context provider is required to consume the context. `ContextProvider<T>`, where `T` is the context struct is used as the provider.
`T` must implement `Clone` and `PartialEq`. `ContextProvider` is the component whose children will have the context available to them.
The children are re-rendered when the context changes.

### Consuming context

#### Struct components

The `ComponentLink::context` method is used to consume contexts in struct components.

##### Example

```rust
struct ContextDemo {
link: ComponentLink<Self>
}

impl Component for ContextDemo {
/// ...
fn view(&self) -> Html {
let theme = self.link.context::<Theme>();
html! {
<button style=format!("background: {}; color: {};", theme.background, theme.foreground)>
{ "Click me!" }
</button>
}
}
}
```

#### Function components

`use_context` hook is used to consume contexts in function components.
See [docs for use_context](function-components/pre-defined-hooks.md#use_context) to learn more.
39 changes: 3 additions & 36 deletions docs/concepts/function-components/pre-defined-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,52 +213,19 @@ use_effect_with_deps(

## `use_context`

`use_context` is used for consuming contexts in function components. See the explanation and example in the following section to learn how to use it.
`use_context` is used for consuming [contexts](../contexts.md) in function components.

### Contexts

Generally data is passed down the component tree using props but that becomes tedious for values such as user preferences, authentication information etc.
Consider the following example which passes down the theme using props:
```rust
// root
let theme = // ...
html! {
<Navbar theme=theme />
}

// Navbar component
html! {
<div>
<Title theme=theme>{ "App title" }<Title>
<NavButton theme=theme>{ "Somewhere" }</NavButton>
</div>
}
```

Passing down data like this isn't ideal for something like a theme which needs to be available everywhere. This is where contexts come in.

Contexts provide a way to share data between components without passing them down explicitly as props.
They make data available to all components in the tree.

#### Using Contexts
### Example

In order to use contexts, we need a struct which defines what data is to be passed.
For the above use-case, consider the following struct:
```rust
/// App theme
#[derive(Clone, Debug, PartialEq)]
struct Theme {
foreground: String,
background: String,
}
```

A context provider is required to consume the context. `ContextProvider<T>`, where `T` is the context struct is used as the provider.
`T` must implement `Clone` and `PartialEq`. `ContextProvider` is the component whose children will have the context available to them.
Let's implement the aforementioned Navbar using contexts and function components with the `use_context` hook.

##### Example

```rust
/// Main component
#[function_component(App)]
pub fn app() -> Html {
Expand Down
3 changes: 2 additions & 1 deletion packages/yew/src/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ pub struct ContextProviderProps<T: Clone + PartialEq> {
/// The context provider component.
///
/// Every child (direct or indirect) of this component may access the context value.
/// Currently the only way to consume the context is using the [`use_context`] hook.
/// In order to consume contexts, [`ComponentLink::context`][Scope::context] method is used,
/// In function components the `use_context` hook is used.
#[derive(Debug)]
pub struct ContextProvider<T: Clone + PartialEq + 'static> {
link: ComponentLink<Self>,
Expand Down
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@
]
},
"concepts/router",
"concepts/agents"
"concepts/agents",
"concepts/contexts"
],
"Advanced topics": [
"advanced-topics/how-it-works",
Expand Down