Struct SideSheetView 

pub struct SideSheetView<State: 'static>(/* private fields */);

A declarative modal M3 side sheet: a header (title + the host’s own close affordance), body, and an optional actions footer, wrapped around the merged crate::overlay::modal host. See the module docs.

Implementations

impl<State: 'static> SideSheetView<State>

pub fn dismissable(self, dismissable: bool) -> Self

Whether the user can dismiss this sheet at all — the scrim tap, the host’s own close affordance, Escape, and an Android back press (default true; see crate::overlay::modal’s module docs). false disables all of them; only an explicit control inside body/ actions still dismisses it.

pub fn on_dismiss<F: Fn(&mut State) + 'static>(self, on_dismiss: F) -> Self

Set the unstaged dismiss callback — delivered with &mut State during the event pass. show_side_sheet wires the staged (navigator-pop, slide-out) path instead; set this only for a Stack-mounted sheet with no navigator underneath it.

pub fn dismiss_handle(self, dismiss: ModalDismiss) -> Self

Install the app-triggered staged-dismiss handle, so an actions button (“Apply”, “Reset”) closes the sheet through the same slide-out ramp the close affordance, the scrim tap, Escape, and a back press take — rather than the raw controller.pop() that dismisses on the spot. See ModalDismiss, and mint the handle outside show_side_sheet’s page builder.

let dismiss = ModalDismiss::new();
let apply = dismiss.clone();
side_sheet(title, body, [
    filled_button("Apply", move |_: &mut State| apply.dismiss()),
])
.dismiss_handle(dismiss.clone())

Trait Implementations

impl<State: 'static> OverlayModalContent<State> for SideSheetView<State>

fn on_modal_dismiss(self, on_dismiss: Rc<dyn Fn(&mut State)>) -> Self

Install the dismiss callback, replacing any the builder already set.

fn modal_dismissable(&self) -> bool

Whether this modal may be dismissed by the user at all — read once, at push time, to pick the page’s BackPolicy.

impl<State: 'static> View<State> for SideSheetView<State>

type Element = OverlayModalWidget

The retained widget this view produces.

fn build(&self, ctx: &mut BuildCtx<'_>) -> OverlayModalWidget

Materialise a fresh widget for this view.

fn rebuild( &self, prev: &Self, element: &mut OverlayModalWidget, ctx: &mut BuildCtx<'_>, ) -> ChangeFlags

Reconcile prev (the previous view of the same type) against the live element, mutating it in place and reporting what changed.

fn teardown(&self, element: &mut OverlayModalWidget, ctx: &mut BuildCtx<'_>)

Tear down element when this view is being removed.

fn message(&self, _element: &mut Self::Element, _state: &mut State)

Deliver an event message to this view, mutating application state.