Struct patternfly_yew::components::toast::Toast

pub struct Toast {
    pub title: String,
    pub type: AlertType,
    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:

#[function_component(App)]
fn app() -> Html {
  html! {
    <>
      <ToastViewer>
        <View/>
      </ToastViewer>
    </>
  }
}
#[function_component(View)]
fn view() -> Html {
  let toaster = use_toaster().expect("Must be nested under a ToastViewer component");
  html!{
    <div>
      <button onclick={move |_| toaster.toast("Toast Title")}>
        { "Click me" }  
      </button>
    </div>
  }
}

Fields

title: String

type: AlertType

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.

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 From<&String> for Toast

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Toast

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Toast

fn from(value: String) -> Self

Converts to this type from the input type.