Skip to main content

DialogProps

Struct DialogProps 

Source
pub struct DialogProps<'__a> {
    pub open: Expr<bool>,
    pub attrs: Attributes,
    pub child: Child<'__a>,
}
Expand description

A panel displayed over the page.

Pass a boolean to open for a fixed state, or a runtime expression to control it in the browser. The overlay blocks clicks on the page behind it. Focus trapping and Escape dismissal require application scripting.

Pass a dialog_content panel as child content. attrs are forwarded to the <dialog>, with extra classes added to its classes. Give the dialog an accessible name with aria-label, or use aria-labelledby to reference its title’s ID.

ⓘ
view! {
    dialog(
        open: confirming,
        dialog_content(
            dialog_header(
                dialog_title("Delete workspace")
                dialog_description("This cannot be undone.")
            )
            dialog_footer(
                // Closing the dialog is navigating to a page that
                // renders it closed.
                <a
                    href="/workspace"
                    class=(button_variants(ButtonVariant::Ghost, ButtonSize::Md))
                >
                    "Cancel"
                </a>
                button(variant: ButtonVariant::Destructive, "Delete")
            )
        )
    )
}

Fields§

§open: Expr<bool>

Whether the dialog shows.

§attrs: Attributes

Extra attributes for the <dialog> element.

§child: Child<'__a>

The dialog’s content.

Implementations§

Source§

impl<'__a> DialogProps<'__a>

Source

pub fn builder() -> DialogPropsBuilder<'__a, open>

Returns a DialogPropsBuilder with no properties set.

Trait Implementations§

Source§

impl<'__a> Props for DialogProps<'__a>

Source§

type Builder = DialogPropsBuilder<'__a>

The builder type in its initial state, with no properties set.
Source§

fn builder() -> Self::Builder

Returns a builder with no properties set.

Auto Trait Implementations§

§

impl<'__a> !RefUnwindSafe for DialogProps<'__a>

§

impl<'__a> !Sync for DialogProps<'__a>

§

impl<'__a> !UnwindSafe for DialogProps<'__a>

§

impl<'__a> Freeze for DialogProps<'__a>

§

impl<'__a> Send for DialogProps<'__a>

§

impl<'__a> Unpin for DialogProps<'__a>

§

impl<'__a> UnsafeUnpin for DialogProps<'__a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

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
Source§

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

Source§

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

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

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