Struct FocusScopeProps

pub struct FocusScopeProps {
    pub loop: MaybeProp<bool>,
    pub trapped: MaybeProp<bool>,
    pub on_mount_auto_focus: Option<Callback<Event>>,
    pub on_unmount_auto_focus: Option<Option<Callback<Event>>>,
    pub as_child: MaybeProp<bool>,
    pub attrs: Vec<(&'static str, Attribute)>,
    pub children: ChildrenFn,
}

Props for the FocusScope component.

Required Props

• attrs: [Vec<(&'static str, Attribute)>]
• children: ChildrenFn

Optional Props

• r#loop: impl Into<MaybeProp<bool>>
  • When true, tabbing from last item will focus first tabbable and shift+tab from first item will focus last tababble. Defaults to false.
• trapped: impl Into<MaybeProp<bool>>
  • When true, focus cannot escape the focus scope via keyboard, pointer, or a programmatic focus. Defaults to false.
• on_mount_auto_focus: impl Into<Callback<Event>>
• on_unmount_auto_focus: impl Into<Option<Callback<Event>>>
• as_child: impl Into<MaybeProp<bool>>

Fields

loop: MaybeProp<bool>

When true, tabbing from last item will focus first tabbable and shift+tab from first item will focus last tababble. Defaults to false.

trapped: MaybeProp<bool>

When true, focus cannot escape the focus scope via keyboard, pointer, or a programmatic focus. Defaults to false.

on_mount_auto_focus: Option<Callback<Event>>

on_unmount_auto_focus: Option<Option<Callback<Event>>>

as_child: MaybeProp<bool>

attrs: Vec<(&'static str, Attribute)>

children: ChildrenFn

Implementations

impl FocusScopeProps

pub fn builder() -> FocusScopePropsBuilder<((), (), (), (), (), (), ())>

Create a builder for building FocusScopeProps. On the builder, call .r#loop(...)(optional), .trapped(...)(optional), .on_mount_auto_focus(...)(optional), .on_unmount_auto_focus(...)(optional), .as_child(...)(optional), .attrs(...)(optional), .children(...) to set the values of the fields. Finally, call .build() to create the instance of FocusScopeProps.

Trait Implementations

impl IntoView for FocusScopeProps

fn into_view(self) -> View

Converts the value into View.