Functions — github.com/NoriginMedia/Norigin-Spatial-Navigation

hub / github.com/NoriginMedia/Norigin-Spatial-Navigation / functions

Functions73 in github.com/NoriginMedia/Norigin-Spatial-Navigation

⨍ Functions 73 ◇ Types & classes 24

↓ 40 callersMethodgetCurrentFocusKey

* Returns the current focus key

src/SpatialNavigation.ts:1175

↓ 33 callersMethodlog

(functionName: string, debugString: string, ...rest: any[])

src/SpatialNavigation.ts:1158

↓ 23 callersMethodnavigateByDirection

* Move focus by direction, if you can't use buttons or focusing by key. * * @example * navigateByDirection('right') // The focus is moved to

src/SpatialNavigation.ts:962

↓ 14 callersMethodsetFocus

(focusKey: string, focusDetails: FocusDetails = {})

src/SpatialNavigation.ts:1646

↓ 8 callersFunctioncreateHorizontalLayout

()

src/__tests__/domNodes.ts:45

↓ 7 callersMethodaddFocusable

({ focusKey, node, parentFocusKey, onEnterPress, onEnterRelease, onArrowPress, onA

src/SpatialNavigation.ts:1303

↓ 6 callersMethodupdateLayout

(focusKey: string)

src/SpatialNavigation.ts:1685

↓ 4 callersMethoddrawPoint

(x: number, y: number, color = 'blue', size = 10)

src/VisualDebugger.ts:126

↓ 4 callersMethodgetNodeLayoutByFocusKey

(focusKey: string)

src/SpatialNavigation.ts:1464

↓ 4 callersMethodisParticipatingFocusableComponent

* Checks whether the focusableComponent is actually participating in spatial navigation (in other words, is a * 'focusable' focusableComponent). Se

src/SpatialNavigation.ts:1607

↓ 3 callersMethodgetKeyMap

()

src/SpatialNavigation.ts:1588

↓ 3 callersMethodgetRefCorners

* Returns two corners (a and b) coordinates that are used as a reference points * Where "a" is always leftmost and topmost corner, and "b" is right

src/SpatialNavigation.ts:299

↓ 3 callersMethodisFocusableComponent

(focusKey: string)

src/SpatialNavigation.ts:1599

↓ 2 callersMethodbindEventHandlers

()

src/SpatialNavigation.ts:756

↓ 2 callersMethodcreateCanvas

( id: string, zIndex: string, writingDirection: WritingDirection )

src/VisualDebugger.ts:41

↓ 2 callersFunctioncreateRootNode

()

src/__tests__/domNodes.ts:3

↓ 2 callersFunctioncreateVerticalLayout

()

src/__tests__/domNodes.ts:169

↓ 2 callersMethodgetCutoffCoordinate

* Used to determine the coordinate that will be used to filter items that are over the "edge"

src/SpatialNavigation.ts:267

↓ 2 callersMethodgetEventType

(keyCode: number | string)

src/SpatialNavigation.ts:748

↓ 2 callersMethodgetForcedFocusKey

* Returns the focus key to which focus can be forced if there are force-focusable components. * A component closest to the top left viewport corner

src/SpatialNavigation.ts:1183

↓ 2 callersMethodgetKeyCode

(event: KeyboardEvent)

src/SpatialNavigation.ts:752

↓ 2 callersFunctiongetRect

(node: HTMLElement)

src/measureLayout.ts:3

↓ 2 callersFunctionmeasureLayout

(node: HTMLElement)

src/measureLayout.ts:24

↓ 2 callersMethodpause

()

src/SpatialNavigation.ts:1638

↓ 2 callersMethodremoveFocusable

({ focusKey }: FocusableComponentRemovePayload)

src/SpatialNavigation.ts:1406

↓ 2 callersMethodsmartNavigate

* This function navigates between siblings OR goes up by the Tree * Based on the Direction

src/SpatialNavigation.ts:990

↓ 2 callersMethodsortSiblingsByPriority

* Inspired by: https://developer.mozilla.org/en-US/docs/Mozilla/Firefox_OS_for_TV/TV_remote_control_navigation#Algorithm_design * Ref Corners are t

src/SpatialNavigation.ts:499

↓ 2 callersMethodunbindEventHandlers

()

src/SpatialNavigation.ts:855

↓ 2 callersMethodupdateFocusable

( focusKey: string, { node, preferredChildFocusKey, focusable, isFocusBoundary

src/SpatialNavigation.ts:1704

↓ 2 callersMethodupdateParentsHasFocusedChild

(focusKey: string, focusDetails: FocusDetails)

src/SpatialNavigation.ts:1514

↓ 2 callersMethodupdateParentsLastFocusedChild

(focusKey: string)

src/SpatialNavigation.ts:1566

↓ 1 callersMethodclear

()

src/VisualDebugger.ts:70

↓ 1 callersMethodclearLayouts

()

src/VisualDebugger.ts:78

↓ 1 callersMethoddrawLayout

(layout: NodeLayout, focusKey: string, parentFocusKey: string)

src/VisualDebugger.ts:86

↓ 1 callersFunctiongetBoundingClientRect

(node: HTMLElement)

src/measureLayout.ts:63

↓ 1 callersFunctiongetBoundingClientRect

()

src/__tests__/measureLayout.test.ts:40

↓ 1 callersFunctiongetChildClosestToOrigin

( children: FocusableComponent[], writingDirection: WritingDirection )

src/SpatialNavigation.ts:153

↓ 1 callersMethodgetNextFocusKey

* This function tries to determine the next component to Focus * It's either the target node OR the one down by the Tree if node has children compo

src/SpatialNavigation.ts:1218

↓ 1 callersMethodisAdjacentSlice

* Calculates if the sibling node is intersecting enough with the ref node by the secondary coordinate

src/SpatialNavigation.ts:390

↓ 1 callersFunctionnormalizeKeyMap

(keyMap: BackwardsCompatibleKeyMap)

src/SpatialNavigation.ts:173

↓ 1 callersMethodonArrowPress

(direction: string, keysDetails: KeyPressDetails)

src/SpatialNavigation.ts:914

↓ 1 callersMethodonArrowRelease

(direction: string)

src/SpatialNavigation.ts:934

↓ 1 callersMethodonEnterPress

(keysDetails: KeyPressDetails)

src/SpatialNavigation.ts:870

↓ 1 callersMethodonEnterRelease

()

src/SpatialNavigation.ts:892

↓ 1 callersMethodonIntermediateNodeBecameBlurred

( focusKey: string, focusDetails: FocusDetails )

src/SpatialNavigation.ts:1626

↓ 1 callersMethodonIntermediateNodeBecameFocused

( focusKey: string, focusDetails: FocusDetails )

src/SpatialNavigation.ts:1614

↓ 1 callersMethodsaveLastFocusedChildKey

(component: FocusableComponent, focusKey: string)

src/SpatialNavigation.ts:1145

↓ 1 callersMethodsetCurrentFocusedKey

(newFocusKey: string, focusDetails: FocusDetails)

src/SpatialNavigation.ts:1476

↓ 1 callersFunctionuseFocusContext

()

src/useFocusContext.ts:8

({ title, color, onEnterPress, onFocus, isShuffleSize, index }: AssetProps)

({ title: rowTitle, onAssetPress, onFocus, isShuffleSize }: ContentRowProps)

src/App.tsx:293

FunctionMenu

({ focusKey: focusKeyParam }: MenuProps)

src/measureLayout.ts:43

Methodconstructor

(writingDirection: WritingDirection)

src/VisualDebugger.ts:25

Methodconstructor

()

src/SpatialNavigation.ts:596

Methoddestroy

()

src/SpatialNavigation.ts:732

MethoddoesFocusableExist

(focusKey: string)

src/SpatialNavigation.ts:1746

Methoddraw

()

src/SpatialNavigation.ts:697

MethodgetPrimaryAxisDistance

( refCorners: Corners, siblingCorners: Corners, isVerticalDirection: boolean )

src/SpatialNavigation.ts:416

MethodgetSecondaryAxisDistance

( refCorners: Corners, siblingCorners: Corners, isVerticalDirection: boolean, distanceCalculat

src/SpatialNavigation.ts:428

Methodinit

({ debug = false, visualDebug = false, nativeMode = false, throttle: throttleParam = 0, th

src/SpatialNavigation.ts:661

MethodisNativeMode

()

src/SpatialNavigation.ts:1742

Methodresume

()

src/SpatialNavigation.ts:1642

Functionright

()

src/measureLayout.ts:40

MethodsetKeyMap

(keyMap: BackwardsCompatibleKeyMap)

src/SpatialNavigation.ts:1592

MethodsetThrottle

({ throttle: throttleParam = 0, throttleKeypresses = false } = {})

src/SpatialNavigation.ts:717

MethodupdateAllLayouts

()

src/SpatialNavigation.ts:1675

MethodupdateRtl

* This function updates the writing direction * @param rtl whether the writing direction is right-to-left

src/SpatialNavigation.ts:1754

FunctionuseFocusableHook

({ focusable = true, saveLastFocusedChild = true, trackChildren = false, autoRestoreFocus = true, fo

src/useFocusable.ts:77