Struct MaterialSideSheet 

pub struct MaterialSideSheet { /* private fields */ }

An M3 side sheet. By default it is a nonmodal standard sheet docked to its parent’s trailing edge that leaves the main content interactive; MaterialSideSheet::modal presents it over the window instead, and MaterialSideSheet::specimen renders it in place. Its controlled visibility retargets the spatial spring, including on close.

Implementations

impl MaterialSideSheet

pub fn new(id: impl Into<ElementId>) -> Self

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

pub fn width(self, width: Rems) -> Self

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

Present over the window with a scrim; Escape, the scrim and the close button dismiss it.

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

Render the sheet’s surface in place, without motion (a specimen).

pub fn edge(self, edge: SideSheetEdge) -> Self

The edge the sheet docks to (default the trailing edge).

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

Present the modal sheet over its positioned parent’s bounds instead of the whole window.

pub fn dismiss_on_scrim(self, dismiss: bool) -> Self

Whether pressing the modal sheet’s scrim dismisses it (default true).

pub fn dismiss_on_escape(self, dismiss: bool) -> Self

Whether Escape dismisses the modal sheet (default true).

pub fn headline(self, headline: impl Into<SharedString>) -> Self

The title-large headline in the header.

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

The modal sheet’s accessible name when it differs from (or there is no) headline.

pub fn back( self, label: impl Into<SharedString>, on_back: impl Fn(&mut Window, &mut App) + 'static, ) -> Self

A leading back button named label.

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

A trailing close button named label; it calls on_dismiss.

pub fn action(self, action: impl IntoElement) -> Self

An action under the divider at the sheet’s bottom, in call order.

pub fn on_dismiss(self, f: impl Fn(&mut Window, &mut App) + 'static) -> Self

Trait Implementations

impl IntoElement for MaterialSideSheet

type Element = ViewElement<MaterialSideSheet>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl ParentElement for MaterialSideSheet

fn extend(&mut self, children: impl IntoIterator<Item = AnyElement>)

Extend this element’s children with the given child elements.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Add a single child element to this element.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Add multiple child elements to this element.

impl RenderOnce for MaterialSideSheet

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.