Backdrop

Struct Backdrop 

Source
pub struct Backdrop {
    pub content: Html,
}
Expand description

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§

Source§

impl Backdrop

Source

pub fn new(content: Html) -> Self

Trait Implementations§

Source§

impl Clone for Backdrop

Source§

fn clone(&self) -> Backdrop

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Backdrop

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Backdrop

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<VNode> for Backdrop

Source§

fn from(content: Html) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

impl<T> HasAllProps<(), T> for T