Struct Checkbox

pub struct Checkbox { /* private fields */ }

A customizable checkbox component.

Example

use yew::prelude::*;
use yewlish_checkbox::{Checkbox, CheckboxIndicator, CheckedState};

#[function_component(App)]
fn app() -> Html {
    html! {
        <Checkbox>
            <CheckboxIndicator show_when={CheckedState::Checked}>{"✔"}</CheckboxIndicator>
        </Checkbox>
    }
}

Trait Implementations

impl BaseComponent for Checkbox

where Self: 'static,

type Message = ()

The Component’s Message.

type Properties = CheckboxProps

The Component’s Properties.

fn create(ctx: &Context<Self>) -> Self

Creates a component.

fn update(&mut self, _ctx: &Context<Self>, _msg: Self::Message) -> bool

Updates component’s internal state.

fn changed( &mut self, _ctx: &Context<Self>, _old_props: &Self::Properties, ) -> bool

React to changes of component properties.

fn view(&self, ctx: &Context<Self>) -> HtmlResult

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

fn destroy(&mut self, _ctx: &Context<Self>)

Notified before a component is destroyed.

fn prepare_state(&self) -> Option<String>

Prepares the server-side state.

impl Debug for Checkbox

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FunctionProvider for Checkbox

type Properties = CheckboxProps

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.