use_bool_toggle

Function use_bool_toggle 

Source
pub fn use_bool_toggle<'hook>(
    default: bool,
) -> impl 'hook + Hook<Output = UseToggleHandle<bool>>
Expand description

This hook is a simplified use_toggle to manage boolean toggle state in a function component.

§Example

use yew_hooks::prelude::*;

#[function_component(Toggle)]
fn toggle() -> Html {
    let toggle = use_bool_toggle(true);

    let onclick = {
        let toggle = toggle.clone();
        Callback::from(move |_| toggle.toggle())
    };
    
    html! {
        <div>
            <button {onclick}>{ "Toggle" }</button>
            <p>
                <b>{ "Current value: " }</b>
                { *toggle }
            </p>
        </div>
    }
}

§Note

When used in function components and hooks, this hook is equivalent to:

/// This hook is a simplified [`use_toggle`] to manage boolean toggle state in a function component.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(Toggle)]
/// fn toggle() -> Html {
///     let toggle = use_bool_toggle(true);
///
///     let onclick = {
///         let toggle = toggle.clone();
///         Callback::from(move |_| toggle.toggle())
///     };
///
///     html! {
///         <div>
///             <button {onclick}>{ "Toggle" }</button>
///             <p>
///                 <b>{ "Current value: " }</b>
///                 { *toggle }
///             </p>
///         </div>
///     }
/// }
/// ```
pub fn use_bool_toggle(default: bool) -> UseToggleHandle<bool> {
    /* implementation omitted */
}