Struct patternfly_yew::Backdrop

pub struct Backdrop {
    pub content: Html,
}

Backdrop overlay the main content and show some new content, until it gets closed.

New content can be sent to the backdrop viewer using the Backdropper::open call. It can be closed using the Backdropper::close call.

Contexts

The BackdropViewer must be wrapped by all contexts which the backdrop content might use, as the content is injected as a child into the backdrop element. So if you can to send toasts from a modal dialog, the [ToastViewer] must be wrapping the BackdropViewer.

Example

#[function_component(App)]
fn app() -> Html {
  html! {
    <>
      <BackdropViewer>
        <View/>
      </BackdropViewer>
    </>
  }
}
#[function_component(View)]
fn view() -> Html {
  let backdropper = use_backdrop().expect("Must be nested under a BackdropViewer component");
  html!{
    <div>
      <button onclick={move |_| backdropper.open(Backdrop::new(
        html! {
            <Bullseye>
                <Modal
                    title = {"Example modal"}
                    variant = { ModalVariant::Medium }
                    description = {"A description is used when you want to provide more info about the modal than the title is able to describe."}
                >
                    <p>{"The modal body can contain text, a form, any nested html will work."}</p>
                </Modal>
            </Bullseye>
        }))
      }>
        { "Click me" }  
      </button>
    </div>
  }
}

Fields

content: Html

Implementations

impl Backdrop

pub fn new(content: Html) -> Self

Trait Implementations

impl Clone for Backdrop

fn clone(&self) -> Backdrop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Backdrop

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

Formats the value using the given formatter.

impl Default for Backdrop

fn default() -> Self

Returns the “default value” for a type.

impl From<VNode> for Backdrop

fn from(content: Html) -> Self

Converts to this type from the input type.