Allow numbers as preferredChildIndex; support updates

jamesplease · Jul 19, 2021 · eded252 · eded252
1 parent 757fe6c
commit eded252
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/src/focus-node.tsx b/src/focus-node.tsx
@@ -385,6 +385,7 @@ export function FocusNode(
       wrapping,
       trap: isTrap,
       forgetTrapFocusHierarchy,
+      preferredChildIndex,
     });
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [
@@ -395,6 +396,7 @@ export function FocusNode(
     wrapping,
     isTrap,
     forgetTrapFocusHierarchy,
+    preferredChildIndex,
   ]);
 
   useEffect(() => {

diff --git a/src/focus-store.ts b/src/focus-store.ts
@@ -29,6 +29,7 @@ interface CreateFocusStoreOptions {
 // When these props of a node change, then the store
 // will alert subscribers.
 const dynamicNodeProps = [
+  'preferredChildIndex',
   'disabled',
   'isExiting',
   'defaultFocusColumn',
@@ -321,6 +322,8 @@ export default function createFocusStore({
         forgetTrapFocusHierarchy:
           update.forgetTrapFocusHierarchy ??
           currentNode.forgetTrapFocusHierarchy,
+        preferredChildIndex:
+          update.preferredChildIndex ?? currentNode.preferredChildIndex,
       };
 
       const updatedChildren = recursivelyUpdateChildren(

diff --git a/src/types.ts b/src/types.ts
@@ -109,7 +109,7 @@ export interface RootFocusNode extends BaseNode {
   wrapping: boolean;
   disabled: boolean;
   trap: boolean;
-  preferredChildIndex?: () => number;
+  preferredChildIndex?: number | (() => number);
 
   defaultFocusColumn: number;
   defaultFocusRow: number;
@@ -136,6 +136,7 @@ export interface NodeUpdate {
   forgetTrapFocusHierarchy?: boolean;
   defaultFocusColumn?: number;
   defaultFocusRow?: number;
+  preferredChildIndex?: number | (() => number);
 }
 
 export interface FocusNode extends BaseNode {
@@ -150,7 +151,7 @@ export interface FocusNode extends BaseNode {
   disabled: boolean;
   navigationStyle: NavigationStyle;
   nodeNavigationItem: NodeNavigationItem;
-  preferredChildIndex?: () => number;
+  preferredChildIndex?: number | (() => number);
 
   defaultFocusColumn: number;
   defaultFocusRow: number;
@@ -191,7 +192,7 @@ export interface NodeDefinition extends FocusNodeEvents {
   trap?: boolean;
   navigationStyle?: NavigationStyle;
   initiallyDisabled?: boolean;
-  preferredChildIndex?: () => number;
+  preferredChildIndex?: number | (() => number);
 
   wrapGridVertical?: boolean;
   wrapGridHorizontal?: boolean;
@@ -254,7 +255,7 @@ export interface FocusNodeProps extends FocusNodeEvents {
   isExiting?: boolean;
   onMountAssignFocusTo?: Id;
   disabled?: boolean;
-  preferredChildIndex?: () => number;
+  preferredChildIndex?: number | (() => number);
 
   onClick?: (e: any) => void;
   onMouseOver?: (e: any) => void;