Struct OverlayPortalView 

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

A declarative overlay portal. See overlay_portal.

Implementations

impl<State: 'static> OverlayPortalView<State>

pub fn overlay(self, overlay: Option<AnyView<State>>) -> Self

The floated surface: Some mounts it, None drops it after the next paint.

The view is diffed against the same application state the portal itself is, so the surface reads and writes app state exactly like the child does — it is a logical child of this call site that happens to be painted elsewhere.

pub fn placement(self, placement: OverlayPlacement) -> Self

Where the surface sits relative to the child’s bounds (default: below, centred — see OverlayPlacement::default).

pub fn band(self, band: OverlayBand) -> Self

Which z-band the surface paints and hit-tests in (default OverlayBand::Floating; a tooltip belongs in OverlayBand::Tooltip).

pub fn input(self, input: OverlayInput) -> Self

Whether the surface takes pointer input (default OverlayInput::Interactive; explanatory chrome the pointer passes through is OverlayInput::Transparent).

pub fn outside_tap(self, outside_tap: OutsideTap) -> Self

What a press landing outside every floated surface delivers here (default OutsideTap::Ignore).

pub fn on_outside_tap(self, callback: impl Fn(&mut State) + 'static) -> Self

Run callback when a press lands outside every floated surface — the light-dismiss hook.

Setting it also opts the surface into the notification (OutsideTap::Notify with consume: true, the modal shape) unless an explicit outside_tap says otherwise, so the tap that dismisses a menu does not also activate what sits under it. Pass OutsideTap::Notify { consume: false } for the pass-through shape.

pub fn preserve_focus(self, preserve: bool) -> Self

Keep the child’s focus session when the surface claims focus (default false).

A surface that is about the child rather than a place to type — a selection toolbar over a field — must not take the field’s focus, or the selection it acts on disappears the moment it is touched. With this set, a focus claim from inside the surface is withdrawn again whenever the child held the focus link, and focus-routed events keep reaching the child. Left false, a surface that claims focus gets it and the child’s link inside this portal is dropped, which is what a popover containing its own text field wants.

Trait Implementations

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

type Element = OverlayPortalWidget<State>

The retained widget this view produces.

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

Materialise a fresh widget for this view.

fn rebuild( &self, prev: &Self, element: &mut OverlayPortalWidget<State>, 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 OverlayPortalWidget<State>, 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.