Struct OverlayDrawerProps

pub struct OverlayDrawerProps {
    pub class: MaybeProp<String>,
    pub container_class: MaybeProp<String>,
    pub open: Model<bool>,
    pub mask_closeable: Signal<bool>,
    pub close_on_esc: bool,
    pub position: Signal<DrawerPosition>,
    pub size: Signal<DrawerSize>,
    pub modal_type: DrawerModalType,
    pub children: Box<dyn FnOnce() -> AnyView + Send>,
}

Props for the OverlayDrawer component.

Required Props

• open: impl Into<Model<bool>>
  • Controls the open state of the Drawer.
• children: Children

Optional Props

• class: impl Into<MaybeProp<String>>
• container_class: impl Into<MaybeProp<String>>
• mask_closeable: impl Into<Signal<bool>>
  • Whether to emit hide event when click mask.
• close_on_esc: impl Into<bool>
  • Whether to close drawer on Esc is pressed.
• position: impl Into<Signal<DrawerPosition>>
  • Position of the drawer.
• size: impl Into<Signal<DrawerSize>>
  • Size of the drawer.
• modal_type: impl Into<DrawerModalType>
  • Dialog variations.

Fields

class: MaybeProp<String>

container_class: MaybeProp<String>

open: Model<bool>

Controls the open state of the Drawer.

mask_closeable: Signal<bool>

Whether to emit hide event when click mask.

close_on_esc: bool

Whether to close drawer on Esc is pressed.

position: Signal<DrawerPosition>

Position of the drawer.

size: Signal<DrawerSize>

Size of the drawer.

modal_type: DrawerModalType

Dialog variations.

children: Box<dyn FnOnce() -> AnyView + Send>

Implementations

impl OverlayDrawerProps

pub fn builder() -> OverlayDrawerPropsBuilder

Create a builder for building OverlayDrawerProps. On the builder, call .class(...)(optional), .container_class(...)(optional), .open(...), .mask_closeable(...)(optional), .close_on_esc(...)(optional), .position(...)(optional), .size(...)(optional), .modal_type(...)(optional), .children(...) to set the values of the fields. Finally, call .build() to create the instance of OverlayDrawerProps.

Trait Implementations

impl Props for OverlayDrawerProps

type Builder = OverlayDrawerPropsBuilder

fn builder() -> <OverlayDrawerProps as Props>::Builder