Struct MaterialBottomSheet 

pub struct MaterialBottomSheet { /* private fields */ }

An M3 bottom sheet. Standard sheets dock to their parent’s bottom edge and leave the content interactive; modal ones present over the window. Dragging the sheet down past its nearest rest dismisses it; otherwise it snaps to the expanded or partial detent.

Implementations

impl MaterialBottomSheet

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

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

Present the sheet while open. Without it the sheet renders in place (a specimen).

pub fn detent(self, detent: BottomSheetDetent) -> Self

Present the sheet at detent (controlled): hidden closes it, and a change moves it to the partial or expanded detent. Report the person’s changes with Self::on_detent_change.

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

Called with the detent a drag, the handle or a dismissal moves the sheet to.

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

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 max_width(self, width: Rems) -> Self

The sheet’s maximum width (default M3’s 640dp).

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

The modal sheet’s accessible name.

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

Show the drag handle; label is its accessible name. Activating it toggles between the partial and expanded detents.

pub fn partial_height(self, height: Rems) -> Self

A partially expanded detent showing height of the sheet; the sheet opens there and expands when dragged up.

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

Called when a drag, Escape or the scrim dismisses the sheet.

Trait Implementations

impl IntoElement for MaterialBottomSheet

type Element = ViewElement<MaterialBottomSheet>

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 MaterialBottomSheet

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 MaterialBottomSheet

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.