Struct FocusTrap 

pub struct FocusTrap { /* private fields */ }

The focus stops of one open overlay, in tab order.

Content re-registers its stops on every render, because the set changes with the content itself.

Implementations

impl FocusTrap

pub fn new() -> Self

pub fn is_engaged(&self) -> bool

pub fn stops(&self) -> &[FocusHandle]

pub fn engage(&mut self, window: &Window, cx: &App)

Records what was focused before the overlay opened, so the same element can be focused again when it closes.

pub fn release(&mut self, window: &mut Window, cx: &mut App)

Restores the previously focused element. Nothing is focused when the element that had focus is gone, rather than guessing at a replacement.

pub fn begin_frame(&mut self)

Clears the registered stops before a render republishes them.

pub fn register(&mut self, handle: FocusHandle)

pub fn focus_first(&self, window: &mut Window, cx: &mut App)

Focuses the first stop, which is what opening an overlay should do.

pub fn focus_next(&self, window: &mut Window, cx: &mut App)

pub fn focus_prev(&self, window: &mut Window, cx: &mut App)

pub fn contains_focus(&self, window: &Window, cx: &App) -> bool

True while focus is inside the overlay.

Trait Implementations

impl Clone for FocusTrap

fn clone(&self) -> FocusTrap

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FocusTrap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FocusTrap

fn default() -> FocusTrap

Returns the “default value” for a type.