Navigation

Navigation primitives for Roku SDK applications

Pages

Page	Description
Bubble	Return from a key handler to pass the key on instead of consuming it.
computeSGPath	Computes the SceneGraph child-index path from root to target.
createBoundaryState	Shared logic for FocusBoundary and RootFocusBoundary.
createFocusRelay	Creates a focus relay bound to initialTarget.
createKeyPressCaptureRegistry	Creates the tree-wide store of captured key presses that a root boundary shares with its descendants.
FocusBoundary	Establishes a virtual focus boundary for a subtree of TypeScript components.
focusIdLabel	Debug label for a focus identity, for use in log output only.
FocusPathContext	Context that RootFocusBoundary provides when its setFocusPath prop is set, so that useFocusable can report which SceneGraph node holds virtual focus.
FocusRelayProvider	Makes a focus relay the focus parent of its children.
ModalBoundary	Renders a custom dialog with its own FocusBoundary, dismissed by the Back key.
onPress	Wraps a handler so it fires only on key-down (press), removing the need for an if (press) guard inside onKey (or onUnhandledKey) handlers.
onRelease	Wraps a handler so it fires only on key-up (release).
RootFocusBoundary	The root of a virtual focus tree for a single anchor node.
ScreenControllerContext	Context for managing the screen stack provided by ScreenControllerProvider.
ScreenControllerProvider	Provider for ScreenControllerContext.
useFocusable	Registers a component instance with the nearest FocusBoundary.
useFocusActions	Returns imperative focus actions for the nearest FocusBoundary.
useFocusRelayTarget	Returns a handle to the nearest enclosing FocusBoundary that focus relays can bind to.
useModal	Creates modal open/close state and focus-transfer actions.
Navigation types	Types shared by several `@roku-sdk/navigation` exports.

Pages

What’s Next