Skip to main content

ModalProps

Struct ModalProps 

Source
pub struct ModalProps {
    pub show: Signal<bool>,
    pub title: String,
    pub body: Option<Element>,
    pub footer: Option<Element>,
    pub size: ModalSize,
    pub backdrop_close: bool,
    pub show_close: bool,
    pub centered: bool,
    pub scrollable: bool,
    pub fullscreen: ModalFullscreen,
    pub class: String,
    pub children: Element,
    /* private fields */
}
Expand description

Bootstrap Modal component — signal-driven, no JavaScript.

Replaces Bootstrap’s <div class="modal"> + JavaScript with a signal-controlled component.

§Bootstrap HTML → Dioxus

<!-- Bootstrap HTML (requires JavaScript) -->
<div class="modal fade" tabindex="-1">
  <div class="modal-dialog modal-lg modal-dialog-centered">
    <div class="modal-content">
      <div class="modal-header"><h5 class="modal-title">Title</h5></div>
      <div class="modal-body"><p>Body</p></div>
      <div class="modal-footer"><button class="btn btn-primary">OK</button></div>
    </div>
  </div>
</div>
// Dioxus equivalent — no JavaScript needed
let show = use_signal(|| false);
rsx! {
    Button { onclick: move |_| show.set(true), "Open Modal" }
    Modal {
        show: show,
        title: "Confirm Action",
        size: ModalSize::Lg,
        centered: true,
        body: rsx! { p { "Are you sure?" } },
        footer: rsx! {
            Button { color: Color::Secondary, onclick: move |_| show.set(false), "Cancel" }
            Button { color: Color::Primary, "Confirm" }
        },
    }
}

§Props

  • showSignal<bool> controlling visibility
  • title — modal title text
  • body — modal body content (Element)
  • footer — modal footer content (Element)
  • sizeModalSize::Sm, Default, Lg, Xl
  • fullscreenModalFullscreen::Off, Always, SmDown..XxlDown
  • centered — vertically center the modal
  • scrollable — scrollable modal body
  • backdrop_close — close when clicking backdrop (default: true)

Fields§

§show: Signal<bool>

Signal controlling modal visibility.

§title: String

Modal title.

§body: Option<Element>

Modal body content.

§footer: Option<Element>

Modal footer content.

§size: ModalSize

Modal size.

§backdrop_close: bool

Close when clicking the backdrop.

§show_close: bool

Show the close button in the header.

§centered: bool

Center the modal vertically.

§scrollable: bool

Allow the modal body to scroll.

§fullscreen: ModalFullscreen

Fullscreen mode.

§class: String

Additional CSS classes for the modal-dialog.

§children: Element

Child elements (alternative to body prop for custom layout).

Implementations§

Source§

impl ModalProps

Source

pub fn builder() -> ModalPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building ModalProps. On the builder, call .show(...), .title(...)(optional), .body(...)(optional), .footer(...)(optional), .size(...)(optional), .backdrop_close(...)(optional), .show_close(...)(optional), .centered(...)(optional), .scrollable(...)(optional), .fullscreen(...)(optional), .class(...)(optional), .attributes(...)(optional), .children(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ModalProps.

Trait Implementations§

Source§

impl Clone for ModalProps

Source§

fn clone(&self) -> ModalProps

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl PartialEq for ModalProps

Source§

fn eq(&self, other: &ModalProps) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Properties for ModalProps
where Self: Clone,

Source§

type Builder = ModalPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.
Source§

fn builder() -> Self::Builder

Create a builder for this component.
Source§

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.
Source§

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent
where M: 'static,

Create a component from the props.
Source§

impl StructuralPartialEq for ModalProps

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
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<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
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<T> DependencyElement for T
where T: 'static + PartialEq + Clone,