Rename nodeCanBeArrowed

jamesplease · Jun 21, 2021 · e7d8505 · e7d8505
1 parent 8856b57
commit e7d8505
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 8 deletions.
diff --git a/src/handle-arrow/determine-navigation-style/get-default-nav-target.ts b/src/handle-arrow/determine-navigation-style/get-default-nav-target.ts
@@ -1,4 +1,4 @@
-import nodeCanBeArrowed from './node-can-be-arrowed';
+import nodeCanReceiveIndirectFocus from '../../utils/node-can-receive-indirect-focus';
 import { FocusState, Node, Orientation, Direction, Id } from '../../types';
 
 export default function getDefaultNavTarget(
@@ -24,7 +24,7 @@ export default function getDefaultNavTarget(
       const parentsChildren = unfilteredChildren.filter((nodeId) => {
         const node = focusState.nodes[nodeId];
 
-        if (!nodeCanBeArrowed(focusState, node)) {
+        if (!nodeCanReceiveIndirectFocus(focusState, node)) {
           return false;
         }
 

diff --git a/...e-navigation-style/node-can-be-arrowed.ts → src/utils/node-can-receive-indirect-focus.ts b/...e-navigation-style/node-can-be-arrowed.ts → src/utils/node-can-receive-indirect-focus.ts
@@ -1,6 +1,16 @@
-import { FocusState, Node } from '../../types';
-
-export default function nodeCanBeArrowed(focusState: FocusState, node?: Node) {
+import { FocusState, Node } from '../types';
+
+// "Indirect focus" here means:
+// 1. receiving focus when a parent node receives focus, either through LRUD input or through an explicit call
+//    to `setFocus`
+// 2. receiving focus after being mounted
+//
+// This function ensures that things like disabled nodes don't receive focus when LRUD is input or when they mount.
+
+export default function nodeCanReceiveIndirectFocus(
+  focusState: FocusState,
+  node?: Node
+) {
   if (!node) {
     return false;
   }
@@ -21,7 +31,10 @@ export default function nodeCanBeArrowed(focusState: FocusState, node?: Node) {
       const childId = children[i];
       const childNode = focusState.nodes[childId];
 
-      const childCanReceiveFocus = nodeCanBeArrowed(focusState, childNode);
+      const childCanReceiveFocus = nodeCanReceiveIndirectFocus(
+        focusState,
+        childNode
+      );
 
       if (childCanReceiveFocus) {
         someChildIsEnabled = true;

diff --git a/src/utils/tree-navigation.ts b/src/utils/tree-navigation.ts
@@ -1,6 +1,6 @@
 import clamp from './clamp';
+import nodeCanReceiveIndirectFocus from './node-can-receive-indirect-focus';
 import { FocusState, Id, NodeHierarchy, Orientation } from '../types';
-import nodeCanBeArrowed from '../handle-arrow/determine-navigation-style/node-can-be-arrowed';
 
 interface GetParentsOptions {
   focusState: FocusState;
@@ -55,7 +55,7 @@ export function getChildren({
   const nodeChildren = node.children.filter((childId) => {
     const node = focusState.nodes[childId];
 
-    return nodeCanBeArrowed(focusState, node);
+    return nodeCanReceiveIndirectFocus(focusState, node);
   });
 
   let nextPreferredChildren: NodeHierarchy = [];