Struct patternfly_yew::Toast

pub struct Toast {
    pub title: String,
    pub type: Type,
    pub timeout: Option<Duration>,
    pub body: Html,
    pub actions: Vec<Action>,
}

Toasts are small alerts that get shown on the top right corner of the page.

A toast can be triggered by every component. The toast fill get sent to an agent, the Toaster. The toaster will delegate displaying the toast to an instance of a ToastViewer component.

In order for Toasts to be displayed your application must have exactly one ToastViewer before creating the first Toast.

For example:

pub struct App{
  link: ComponentLink<Self>
};
pub enum Msg {
  Toast(Toast),
}
type Message = Msg;

fn update(&mut self, msg: Self::Message) -> bool {
  match msg {
    Msg::Toast(toast) => {
      ToastDispatcher::new().toast(toast);
      false
    }
  }
}


fn view(&self) -> Html {
 html!{
    <>
      <ToastViewer/>
      <div>
        <button onclick=self.link.callback(|_|{
            Msg::Toast("Toast Title".into())
        })>
          { "Click me" }  
        </button>
      </div>
    </>
  }
}

Fields

title: String

type: Type

timeout: Option<Duration>

The timeout when the toast will be removed automatically.

If no timeout is set, the toast will get a close button.

body: Html

actions: Vec<Action>

Trait Implementations

impl Clone for Toast

fn clone(&self) -> Toast

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Toast

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

Formats the value using the given formatter.

impl Default for Toast

fn default() -> Toast

Returns the "default value" for a type.

impl<S: ToString> From<S> for Toast

Allows to convert a string into a toast by using the string as title.

fn from(message: S) -> Self

Performs the conversion.