use-focus-return
Capture last focused element on the page and return focus to it once condition is met
Import
Source
Docs
Package
Usage
use-focus-return automatically manages focus returning to last focused element when given condition is met. For example it is used in Modal component to restore focus after modal was closed.
Try closing modal with escape key and see how focus returns to button after modal transition finishes:
In most cases you would want to use this hook with use-focus-trap.
To use hook provide opened and transitionDuration settings:
useFocusReturn({// Is region with focus trap active?// When it activates hook saves document.activeElement to internal state// and focuses this element once focus trap is deactivatedopened: false,// Transition duration in ms, used to set timeout as element cannot be focused when focus trap is activetransitionDuration: 200,});
Definition
function useFocusReturn(settings: { opened: boolean; transitionDuration: number }): void;
Built by Vitaly Rtishchev and these awesome people