pub struct SideSheet { /* private fields */ }Expand description
An overlay panel anchored to a viewport edge.
SideSheet is suitable for responsive inspectors, conversation drawers,
and focused configuration flows. It shares SUI’s dialog surface, spacing,
elevation, motion, focus, and semantic contracts while using a horizontal
reveal appropriate to a drawer.
Implementations§
Source§impl SideSheet
impl SideSheet
pub fn new<W>(title: impl Into<String>, body: W) -> SideSheetwhere
W: Widget + 'static,
pub fn theme(self, theme: DefaultTheme) -> SideSheet
pub fn theme_when<F>(self, theme: F) -> SideSheetwhere
F: Fn() -> DefaultTheme + 'static,
pub fn description(self, description: impl Into<String>) -> SideSheet
pub fn shown(self, shown: bool) -> SideSheet
pub fn is_shown(&self) -> bool
pub fn set_shown(&mut self, shown: bool) -> bool
pub fn state(self, state: SheetState) -> SideSheet
pub fn modal(self, modal: bool) -> SideSheet
pub fn dismiss_on_scrim(self, dismiss_on_scrim: bool) -> SideSheet
pub fn placement(self, placement: SideSheetPlacement) -> SideSheet
pub fn width(self, width: f32) -> SideSheet
Sourcepub fn height(self, height: f32) -> SideSheet
pub fn height(self, height: f32) -> SideSheet
Set the panel height when placed at SideSheetPlacement::Bottom.
pub fn header_action<W>(self, action: W) -> SideSheetwhere
W: Widget + 'static,
pub fn action<W>(self, action: W) -> SideSheetwhere
W: Widget + 'static,
pub fn primary_action<F>(
self,
label: impl Into<String>,
on_press: F,
) -> SideSheetwhere
F: FnMut() + 'static,
pub fn secondary_action<F>(
self,
label: impl Into<String>,
on_press: F,
) -> SideSheetwhere
F: FnMut() + 'static,
pub fn on_dismiss<F>(self, on_dismiss: F) -> SideSheetwhere
F: FnMut() + 'static,
Trait Implementations§
Source§impl Widget for SideSheet
impl Widget for SideSheet
Source§fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)
Receive a typed command addressed directly to this widget. Commands are
target-only and do not capture or bubble through the widget tree.
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)
fn paint(&self, ctx: &mut PaintCtx)
fn layer_options(&self) -> LayerOptions
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Describe this widget as the logical owner of a presented overlay. Read more
fn semantics(&self, ctx: &mut SemanticsCtx)
fn accepts_focus(&self) -> bool
fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)
Source§fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
Visit this widget’s logical children. Read more
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Mutably visit this widget’s logical children. Read more
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Publish widget-specific state for an inspector snapshot. Read more
Source§fn intrinsic_size(
&mut self,
ctx: &mut MeasureCtx,
axis: Axis,
available_cross: f32,
) -> IntrinsicSize
fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize
Report the smallest and preferred extent along one axis. Read more
fn layer_properties(&self) -> LayerProperties
fn stack_host_options(&self) -> Option<StackHostOptions>
Auto Trait Implementations§
impl !RefUnwindSafe for SideSheet
impl !Send for SideSheet
impl !Sync for SideSheet
impl !UnwindSafe for SideSheet
impl Freeze for SideSheet
impl Unpin for SideSheet
impl UnsafeUnpin for SideSheet
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.