Merge pull request #291 from theKashey/correct-typescript-for-hooks

fix: correct typescript definitions for focus helpers
theKashey · Feb 28, 2024 · e7cc578 · e7cc578
2 parents ba96b00 + 02adc7b
commit e7cc578
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 10 deletions.
diff --git a/UI/UI.d.ts b/UI/UI.d.ts
@@ -59,20 +59,20 @@ export type FocusControl = {
      * focuses the next element in the scope.
      * If active element is not in the scope, autofocus will be triggered first
      */
-    focusNext(options:FocusOptions):Promise<void>;
+    focusNext(options?:FocusOptions):Promise<void>;
     /**
      * focuses the prev element in the scope.
      * If active element is not in the scope, autofocus will be triggered first
      */
-    focusPrev():Promise<void>;
+    focusPrev(options?:FocusOptions):Promise<void>;
     /**
      * focused the first element in the scope
      */
-    focusFirst(options: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
+    focusFirst(options?: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
     /**
      * focused the last element in the scope
      */
-    focusLast(options: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
+    focusLast(options?: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
 }
 
 
@@ -81,7 +81,7 @@ export type FocusControl = {
  * - can be used outside of FocusLock
  * @see {@link useFocusScope} for use cases inside of FocusLock
  */
-export function useFocusController(...shards: HTMLElement[]):FocusControl;
+export function useFocusController<Elements extends HTMLElement=HTMLElement>(...shards: ReadonlyArray<HTMLElement | {current:HTMLElement | null}>):FocusControl;
 
 /**
  * returns FocusControl over the current FocusLock

diff --git a/react-focus-lock.d.ts b/react-focus-lock.d.ts
@@ -59,29 +59,30 @@ export type FocusControl = {
      * focuses the next element in the scope.
      * If active element is not in the scope, autofocus will be triggered first
      */
-    focusNext(options:FocusOptions):Promise<void>;
+    focusNext(options?:FocusOptions):Promise<void>;
     /**
      * focuses the prev element in the scope.
      * If active element is not in the scope, autofocus will be triggered first
      */
-    focusPrev():Promise<void>;
+    focusPrev(options?:FocusOptions):Promise<void>;
     /**
      * focused the first element in the scope
      */
-    focusFirst(options: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
+    focusFirst(options?: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
     /**
      * focused the last element in the scope
      */
-    focusLast(options: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
+    focusLast(options?: Pick<FocusOptions,'onlyTabbable'>):Promise<void>;
 }
 
 
 /**
  * returns FocusControl over the union given elements, one or many
  * - can be used outside of FocusLock
+ * - can accept HTML elements or React Refs
  * @see {@link useFocusScope} for use cases inside of FocusLock
  */
-export function useFocusController(...shards: HTMLElement[]):FocusControl;
+export function useFocusController<Elements extends HTMLElement=HTMLElement>(...shards: ReadonlyArray<HTMLElement | {current:HTMLElement | null}>):FocusControl;
 
 /**
  * returns FocusControl over the current FocusLock