add support for focus options on returnFocus.

Closes theKashey#83
nickspaargaren · Sep 12, 2019 · 4e66fdc · 4e66fdc
1 parent 4e779e8
commit 4e66fdc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/interfaces.d.ts b/interfaces.d.ts
@@ -4,9 +4,11 @@ export interface ReactFocusLockProps {
   disabled?: boolean;
 
   /**
-   * will return focus to the previous position on trap disable.
+   * if true, will return focus to the previous position on trap disable.
+   * Optionally, can pass focus options instead of `true` to control the focus
+   * more precisely (ie. `{ preventScroll: true }`)
    */
-  returnFocus?: boolean;
+  returnFocus?: boolean | FocusOptions;
 
   /**
    * @deprecated Use persistentFocus=false instead

diff --git a/src/Lock.js b/src/Lock.js
@@ -56,8 +56,9 @@ function FocusLock(props) {
 
   const returnFocus = useCallback(() => {
     const { current } = originalFocusedElement;
-    if (shouldReturnFocus && current && current.focus) {
-      current.focus();
+    if (Boolean(shouldReturnFocus) && current && current.focus) {
+      const focusOptions = typeof shouldReturnFocus === 'object' ? shouldReturnFocus : undefined;
+      current.focus(focusOptions);
       originalFocusedElement.current = null;
     }
   }, []);
@@ -138,7 +139,7 @@ function FocusLock(props) {
 FocusLock.propTypes = {
   children: node.isRequired,
   disabled: bool,
-  returnFocus: bool,
+  returnFocus: oneOfType([bool, object]),
   noFocusGuards: bool,
 
   allowTextSelection: bool,