Struct perspective_viewer::custom_elements::modal::ModalElement

pub struct ModalElement<T>
where
    T: Component,
    T::Properties: ModalLink<T>,
{
    pub custom_element: HtmlElement,
    /* private fields */
}

A ModalElement wraps the parameterized yew Component in a Custom Element. Via the open() and close() methods, a ModalElement can be positioned next to any existing on-page elements, accounting for viewport, scroll position, etc.

#[derive(Clone)] generates the trait bound T: Clone, which is not required because Scope<T> implements Clone without this bound; thus Clone must be implemented by the derivative crate’s custom bounds support.

Fields

custom_element: HtmlElement

Implementations

impl<T> ModalElement<T>

where T: Component, T::Properties: ModalLink<T>,

pub fn new( custom_element: HtmlElement, props: T::Properties, own_focus: bool, on_blur: Option<Callback<()>>, ) -> Self

pub fn send_message(&self, msg: T::Message)

pub fn send_message_batch(&self, msgs: Vec<T::Message>)

pub fn send_future_batch<Fut>(&self, future: Fut)

where Fut: Future + 'static, Fut::Output: SendAsMessage<Modal<T>>,

pub async fn open( self, target: HtmlElement, resize_pubsub: Option<&PubSub<()>>, ) -> ApiResult<()>

Open this modal by attaching directly to document.body with position absolutely positioned relative to an alread-connected target element.

Because the Custom Element has a blur handler, we must invoke this before attempting to re-parent the element.

pub fn is_open(&self) -> bool

pub fn hide(&self) -> ApiResult<()>

Remove from document.

pub fn destroy(self) -> ApiResult<()>

Remove from document and cleanup.

Trait Implementations

impl<T> Clone for ModalElement<T>

where T: Component, T::Properties: ModalLink<T>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.