Module yew::functional

Function components are a simplified version of normal components. They consist of a single function annotated with the attribute #[function_component(_)] that receives props and determines what should be rendered by returning Html.

#[function_component(HelloWorld)]
fn hello_world() -> Html {
    html! { "Hello world" }
}

More details about function components and Hooks can be found on Yew Docs

Structs

FunctionComponent

Wrapper that allows a struct implementing FunctionProvider to be consumed as a component.

HookUpdater

The HookUpdater provides a convenient interface for hooking into the lifecycle of the underlying Yew Component that backs the function component.

UseReducerDispatcher

Dispatcher handle for use_reducer and use_reducer_eq hook

UseReducerHandle

State handle for use_reducer and use_reducer_eq hook

UseStateHandle

State handle for the use_state hook.

UseStateSetter

Setter handle for use_state and use_state_eq hook

Traits

FunctionProvider

Trait that allows a struct to act as Function Component.

Reducible

A trait that implements a reducer function of a type.

Functions

use_context

Hook for consuming context values in function components. The context of the type passed as T is returned. If there is no such context in scope, None is returned. A component which calls use_context will re-render when the data of the context changes.

use_effect

This hook is used for hooking into the component’s lifecycle.

use_effect_with_deps

This hook is similar to use_effect but it accepts dependencies.

use_hook

Low level building block of creating hooks.

use_mut_ref

This hook is used for obtaining a mutable reference to a stateful value. Its state persists across renders.

use_node_ref

This hook is used for obtaining a NodeRef. It persists across renders.

use_reducer

This hook is an alternative to use_state. It is used to handle component’s state and is used when complex actions needs to be performed on said state.

use_reducer_eq

use_reducer but only re-renders when prev_state != next_state.

use_ref

This hook is used for obtaining a immutable reference to a stateful value. Its state persists across renders.

use_state

This hook is used to manage state in a function component.

use_state_eq

use_state but only re-renders when prev_state != next_state.

Attribute Macros

function_component

This attribute creates a function component from a normal Rust function.