Struct yew_styles::modal::Modal

pub struct Modal { /* fields omitted */ }

Modal component

Features required

modal

Example

use wasm_bindgen::JsCast;
use web_sys::HtmlElement;
use yew::prelude::*;
use yew::utils::document;
use yew_prism::Prism;
use yew_styles::button::Button;
use yew_styles::modal::Modal;
use yew_styles::styles::{get_size, Palette, Size, Style};

pub struct ModalExample {
    link: ComponentLink<Self>,
    show_modal: bool,
}

pub enum Msg {
    CloseModal,
    OpenModal,
    CloseModalByKb(KeyboardEvent),
}

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

    fn create(_: Self::Properties, link: ComponentLink<Self>) -> Self {
        Self {
            link,
            show_modal: false,
        }
    }

    fn update(&mut self, msg: Self::Message) -> ShouldRender {
        let body_style = document()
            .body()
            .unwrap()
            .dyn_into::<HtmlElement>()
            .unwrap()
            .style();

        match msg {
            Msg::CloseModal(index) => {
                body_style.set_property("overflow", "auto").unwrap();
                self.show_modal = false;
            }
            Msg::CloseModalByKb(keyboard_event) => {
                if keyboard_event.key_code() == 27 {
                    body_style.set_property("overflow", "auto").unwrap();
                    self.show_modal = false;
                }
            }
            Msg::OpenModal => {
                body_style.set_property("overflow", "hidden").unwrap();

                self.show_modal = true;
            }
        };
        true
    }

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

    fn view(&self) -> Html {
        html! {
            <>
                <Modal
                    header=html!{
                        <b>{"Standard modal"}</b>
                    }
                    header_palette=Palette::Link
                    body=html!{
                        <div class="body-content">
                            <p>{"This is a example modal"}</p>
                            <Button
                                button_palette= Palette::Info
                                onclick_signal= self.link.callback(|_| Msg::CloseModal)
                            >{"Accept"}</Button>
                        </div>
                    }
                    body_style=Style::Outline
                    body_palette=Palette::Link
                    is_open=self.show_modal
                    onclick_signal= self.link.callback(|_| Msg::CloseModal)
                    onkeydown_signal= self.link.callback(Msg::CloseModalByKb)
                />
                <Button
                    button_palette= Palette::Primary
                    onclick_signal= self.link.callback(Msg::OpenModal)
                >{"Standard modal"}</Button>
            </>
        }
    }
}

Trait Implementations

impl Component for Modal

type Message = Msg

Messages are used to make Components dynamic and interactive. Simple Component's can declare their Message type to be (). Complex Component's commonly use an enum to declare multiple Message types.

type Properties = Props

Properties are the inputs to a Component and should not mutated within a Component. They are passed to a Component using a JSX-style syntax. # use yew::{Html, Component, Properties, ComponentLink, html}; # struct Model; # #[derive(Clone, Properties)] # struct Props { # prop: String, # } # impl Component for Model { # type Message = ();type Properties = Props; # fn create(props: Self::Properties,link: ComponentLink<Self>) -> Self {unimplemented!()} # fn update(&mut self,msg: Self::Message) -> bool {unimplemented!()} # fn change(&mut self, _: Self::Properties) -> bool {unimplemented!()} # fn view(&self) -> Html { html! { <Model prop="value" /> } # }}

fn create(props: Self::Properties, link: ComponentLink<Self>) -> Self

Components are created with their properties as well as a ComponentLink which can be used to send messages and create callbacks for triggering updates.

fn update(&mut self, msg: Self::Message) -> ShouldRender

Components handle messages in their update method and commonly use this method to update their state and (optionally) re-render themselves.

fn change(&mut self, props: Self::Properties) -> ShouldRender

When the parent of a Component is re-rendered, it will either be re-created or receive new properties in the change lifecycle method. Component's can choose to re-render if the new properties are different than the previously received properties. Most Component's will use props with a PartialEq impl and will be implemented like this: # use yew::{Html, Component, ComponentLink, html, ShouldRender}; # struct Model{props: ()}; # impl Component for Model { # type Message = ();type Properties = (); # fn create(props: Self::Properties,link: ComponentLink<Self>) -> Self {unimplemented!()} # fn update(&mut self,msg: Self::Message) -> bool {unimplemented!()} # fn view(&self) -> Html {unimplemented!()} fn change(&mut self, props: Self::Properties) -> ShouldRender { if self.props != props { self.props = props; true } else { false } } # } Components which don't have properties should always return false.

fn rendered(&mut self, _first_render: bool)

The rendered method is called after each time a Component is rendered but before the browser updates the page. ## Examples ```rust # use yew::{Html, Component, ComponentLink, html, ShouldRender}; # struct Model{props: ()}; # impl Model { fn setup_element(&self) { } } # impl Component for Model { # type Message = ();type Properties = (); # fn create(props: Self::Properties,link: ComponentLink) -> Self {unimplemented!()} # fn update(&mut self,msg: Self::Message) -> bool {unimplemented!()} # fn view(&self) -> Html {unimplemented!()} # fn change(&mut self, _props: Self::Properties) -> ShouldRender { unimplemented!() } fn rendered(&mut self, first_render: bool) { if first_render { self.setup_element(); // Similar to 'mounted' in other frameworks } } # }

fn view(&self) -> Html

Components define their visual layout using a JSX-style syntax through the use of the html! procedural macro. The full guide to using the macro can be found in Yew's documentation.

fn destroy(&mut self)

The destroy method is called right before a Component is unmounted.