ModalElement

Struct ModalElement 

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

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§

Source§

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

Source

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

Source

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

Source

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

Source

pub fn send_future_batch<Fut>(&self, future: Fut)
where Fut: Future + 'static, Fut::Output: SendAsMessage<Modal<T>>,

Source

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.

Source

pub fn is_open(&self) -> bool

Source

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

Remove from document.

Source

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

Remove from document and cleanup.

Trait Implementations§

Source§

impl<T> Clone for ModalElement<T>
where T: Component, T::Properties: ModalLink<T>,

Source§

fn clone(&self) -> Self

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

Auto Trait Implementations§

§

impl<T> Freeze for ModalElement<T>

§

impl<T> !RefUnwindSafe for ModalElement<T>

§

impl<T> !Send for ModalElement<T>

§

impl<T> !Sync for ModalElement<T>

§

impl<T> Unpin for ModalElement<T>

§

impl<T> !UnwindSafe for ModalElement<T>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
Source§

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

Source§

fn tee<const N: usize>(self) -> <T as TeeInternal<N>>::Output
where T: TeeInternal<N>,

Extension method to add tee() method to all T: Clone. Read more
§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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