Struct OverlayModalView 

pub struct OverlayModalView<State: 'static> { /* private fields */ }

A declarative modal host. See overlay_modal.

The fields are crate-visible so the catalog’s modal components can wrap one and adjust its config in their own builders (a dialog is a pre-configured modal host); an app outside the crate configures it through overlay_modal’s config argument and the builders below.

Implementations

impl<State: 'static> OverlayModalView<State>

pub fn label(self, label: impl Into<String>) -> Self

Label the modal’s accessibility node (its title text).

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

Whether the user can dismiss this modal at all — the scrim tap, the close affordance, the handle, a drag commit, Escape, and an Android back press (default true; see the module docs). false disables all six; only an explicit control the app wires through its own content 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.

Used only when no on_close hook is wired: with one, the dismissal is staged behind the exit ramp and fired from paint, where no app state exists (see the module docs).

pub fn on_close<F: Fn() + 'static>(self, on_close: F) -> Self

Set the state-free close hook fired when the exit ramp settles — the staged-dismissal path. show_overlay_modal wires this to controller.pop(); a Stack-mounted modal wires its own (a signal write, a navigator pop).

Pinned at build: a directly constructed (non-staged) view’s later rebuilds neither update nor clear this hook once installed — see OverlayModalWidget’s on_close field doc for why.

An app hook is wrapped unguarded: only the navigator pop show_overlay_modal wires has a stack identity to check.

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

Install the app-triggered staged-dismiss handle: the panel’s own content can then close it through the very ramp the host chrome uses, instead of the raw, unstaged controller.pop() that was its only route before (see the module docs’ app-initiated dismiss section, and ModalDismiss for the worked example).

Mint the handle outside a show_* page builder and clone it in — the builder re-runs on every navigator rebuild.

pub fn snap_points(self, points: &[f64]) -> Self

Set the drag’s snap points: 0..=1 a fraction of the panel’s own extent, above 1 logical px (see the module docs). The panel opens to the first point — except a first point of 0.0 itself, which OverlayModalWidget::open_progress treats as absent (fully open) rather than authoring a panel that opens already closed.

A non-finite point (NaN or infinite — never a meaningful fraction or px extent) is dropped here, at the boundary, rather than stored: this is the one place caller input enters the widget, and every downstream consumer (normalize_snap, snap_targets, open_progress) trusts OverlayModalWidget::snap_points to already be all-finite rather than re-checking (see the module docs’s Clamp Discipline section). A caller-authored NaN/∞ behaves as if that point were never passed at all.

Trait Implementations

impl<State: 'static> OverlayModalContent<State> for OverlayModalView<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 OverlayModalView<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.