Struct OverlayModalConfig 

pub struct OverlayModalConfig {
    pub geometry: OverlayGeometry,
    pub corners: OverlayCorners,
    pub border: OverlayBorder,
    pub container: OverlayContainer,
    pub elevation: OverlayElevation,
    pub entrance: OverlayEntrance,
    pub scrim_dismiss: bool,
    pub close_button: bool,
    pub handle: bool,
    pub drag: bool,
    pub role: OverlayRole,
}

The chrome differences between the modal families — see the module docs.

Fields

geometry: OverlayGeometry

Where the panel sits.

corners: OverlayCorners

Which corners round.

border: OverlayBorder

Which edges carry an outline.

container: OverlayContainer

The surfaceContainer* rung the panel fills with.

elevation: OverlayElevation

The panel’s elevation rung.

entrance: OverlayEntrance

How the panel enters.

scrim_dismiss: bool

Whether a press+release outside the panel dismisses.

close_button: bool

Whether the close affordance is shown.

handle: bool

Whether the drag-handle bar is shown (and dismisses on release).

drag: bool

Whether the panel can be dragged along its own edge axis to close (see the module docs). Meaningful only for an OverlayGeometry::Edge panel.

role: OverlayRole

The accessibility role.

Implementations

impl OverlayModalConfig

pub fn centered(max_width: f64) -> Self

The M3 dialog chrome: a centred, fully-rounded surfaceContainerHigh panel at elevation 3, capped at max_width, fading and scaling in.

pub fn edge(side: OverlaySide) -> Self

The M3 sheet chrome on side: a surfaceContainerLow panel at elevation 1 pinned to that edge, rounded on the two corners facing into the screen, sliding in.

A left/right side sheet is OVERLAY_EDGE_FRACTION of the width capped at OVERLAY_SIDE_SHEET_MAX_WIDTH and full height; a top/bottom sheet is content-tall and full width.

pub fn extent(self, extent: OverlayExtent, limit: OverlayLimit) -> Self

Replace the panel’s extent along its own axis (an OverlayGeometry::Edge config only; a no-op on a centred one).

pub fn corners(self, corners: OverlayCorners) -> Self

Set which corners round.

pub fn border(self, border: OverlayBorder) -> Self

Set which edges carry an outline.

pub fn container(self, container: OverlayContainer) -> Self

Set the panel’s container rung.

pub fn elevation(self, elevation: OverlayElevation) -> Self

Set the panel’s elevation rung.

pub fn entrance(self, entrance: OverlayEntrance) -> Self

Set the entrance.

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

Enable or disable scrim-tap dismissal.

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

Show or hide the close affordance.

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

Show or hide the drag handle.

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

Enable or disable drag-to-close (see OverlayModalConfig::drag).

pub fn role(self, role: OverlayRole) -> Self

Set the accessibility role.

Trait Implementations

impl Clone for OverlayModalConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayModalConfig

impl Debug for OverlayModalConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OverlayModalConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OverlayModalConfig