Struct OffcanvasProps 

pub struct OffcanvasProps {
    pub show: Signal<bool>,
    pub title: String,
    pub placement: OffcanvasPlacement,
    pub backdrop_close: bool,
    pub backdrop: bool,
    pub show_close: bool,
    pub responsive: String,
    pub class: String,
    pub children: Element,
}

Bootstrap Offcanvas (slide-in sidebar) — signal-driven, no JavaScript.

Bootstrap HTML → Dioxus

<!-- Bootstrap HTML (requires JavaScript) -->
<button data-bs-toggle="offcanvas" data-bs-target="#sidebar">Open</button>
<div class="offcanvas offcanvas-start" id="sidebar">
  <div class="offcanvas-header"><h5>Menu</h5><button class="btn-close" data-bs-dismiss="offcanvas"></button></div>
  <div class="offcanvas-body">Content</div>
</div>

// Dioxus equivalent
let show = use_signal(|| false);
rsx! {
    Button { onclick: move |_| show.set(true), "Open Sidebar" }
    Offcanvas { show: show, title: "Menu", placement: OffcanvasPlacement::Start,
        Nav { vertical: true, pills: true,
            NavItem { NavLink { active: true, "Home" } }
            NavItem { NavLink { "Settings" } }
        }
    }
}

Props

• show — Signal<bool> controlling visibility
• title — header title
• placement — OffcanvasPlacement::Start, End, Top, Bottom
• backdrop — show backdrop overlay (default: true)
• backdrop_close — close on backdrop click (default: true)
• responsive — responsive variant breakpoint (e.g., “lg”)

Fields

show: Signal<bool>

Signal controlling visibility.

title: String

Title shown in the offcanvas header.

placement: OffcanvasPlacement

Placement (which side it slides in from).

backdrop_close: bool

Close when clicking the backdrop.

backdrop: bool

Show backdrop overlay.

show_close: bool

Show close button.

responsive: String

Responsive variant — offcanvas only below this breakpoint. E.g., “lg” makes it offcanvas below lg, regular content above.

class: String

Additional CSS classes.

children: Element

Child elements (offcanvas body content).

Implementations

impl OffcanvasProps

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

Create a builder for building OffcanvasProps. On the builder, call .show(...), .title(...)(optional), .placement(...)(optional), .backdrop_close(...)(optional), .backdrop(...)(optional), .show_close(...)(optional), .responsive(...)(optional), .class(...)(optional), .children(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of OffcanvasProps.

Trait Implementations

impl Clone for OffcanvasProps

fn clone(&self) -> OffcanvasProps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for OffcanvasProps

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Properties for OffcanvasProps

where Self: Clone,

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

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

fn builder() -> Self::Builder

Create a builder for this component.

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.

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

where M: 'static,

Create a component from the props.

impl StructuralPartialEq for OffcanvasProps