@decky/ui 4.8.1 → 4.8.3

package/dist/components/FooterLegend.d.ts

@@ -31,11 +31,11 @@ export declare enum GamepadButton {
     STEAM_QUICK_MENU = 28
 }
 export declare enum NavEntryPositionPreferences {
-    FIRST,
-    LAST,
-    MAINTAIN_X,
-    MAINTAIN_Y,
-    PREFERRED_CHILD
+    FIRST = 0,
+    LAST = 1,
+    MAINTAIN_X = 2,
+    MAINTAIN_Y = 3,
+    PREFERRED_CHILD = 4
 }
 export interface GamepadEventDetail {
     button: number;
@@ -47,6 +47,8 @@ export declare type ActionDescriptionMap = {
 };
 export declare type GamepadEvent = CustomEvent<GamepadEventDetail>;
 export interface FooterLegendProps {
+    navEntryPreferPosition?: NavEntryPositionPreferences;
+    preferredFocus?: boolean;
     actionDescriptionMap?: ActionDescriptionMap;
     onOKActionDescription?: ReactNode;
     onCancelActionDescription?: ReactNode;

package/dist/components/FooterLegend.js

@@ -30,3 +30,11 @@ export var GamepadButton;
     GamepadButton[GamepadButton["STEAM_GUIDE"] = 27] = "STEAM_GUIDE";
     GamepadButton[GamepadButton["STEAM_QUICK_MENU"] = 28] = "STEAM_QUICK_MENU";
 })(GamepadButton || (GamepadButton = {}));
+export var NavEntryPositionPreferences;
+(function (NavEntryPositionPreferences) {
+    NavEntryPositionPreferences[NavEntryPositionPreferences["FIRST"] = 0] = "FIRST";
+    NavEntryPositionPreferences[NavEntryPositionPreferences["LAST"] = 1] = "LAST";
+    NavEntryPositionPreferences[NavEntryPositionPreferences["MAINTAIN_X"] = 2] = "MAINTAIN_X";
+    NavEntryPositionPreferences[NavEntryPositionPreferences["MAINTAIN_Y"] = 3] = "MAINTAIN_Y";
+    NavEntryPositionPreferences[NavEntryPositionPreferences["PREFERRED_CHILD"] = 4] = "PREFERRED_CHILD";
+})(NavEntryPositionPreferences || (NavEntryPositionPreferences = {}));

package/dist/utils/index.js

@@ -13,7 +13,7 @@ export function findSP() {
     if (document.title == 'SP')
         return window;
     const navTrees = getGamepadNavigationTrees();
-    return navTrees?.find((x) => x.m_ID == 'root_1_')?.Root?.Element?.ownerDocument?.defaultView;
+    return navTrees?.find((x) => x.m_ID == 'GamepadUI_Full_Root' || x.m_ID == 'root_1_')?.Root?.Element?.ownerDocument?.defaultView;
 }
 export function getFocusNavController() {
     return window.GamepadNavTree?.m_context?.m_controller || window.FocusNavController;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decky/ui",
-  "version": "4.8.1",
+  "version": "4.8.3",
   "description": "A library for interacting with the Steam frontend in Decky plugins and elsewhere.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/components/FooterLegend.ts

@@ -31,11 +31,42 @@ export enum GamepadButton {
   STEAM_GUIDE,
   STEAM_QUICK_MENU,
 }
-export declare enum NavEntryPositionPreferences {
+export enum NavEntryPositionPreferences {
+  /**
+   * Always give focus to the first child element.
+   */
   FIRST,
+
+  /**
+   * Always give focus to the last child element.
+   */
   LAST,
+
+  /**
+   * Give focus to the child element that would maintain the flow in the X axis.
+   * 
+   * Imagine you have a calculator window with 9 standard buttons.
+   * You have 3 rows of buttons, with 3 buttons per row.
+   * If you select button with number 8 and navigate down, the buttons
+   * will be navigated in the following order 8->5->3.
+   * The flow is maintained for the X axis while you're navigating the Y axis.
+   */
   MAINTAIN_X,
+
+  /**
+   * Give focus to the child element that would maintain the flow in the Y axis.
+   * 
+   * Imagine you have a calculator window with 9 standard buttons.
+   * You have 3 columns of buttons, with 3 buttons per column.
+   * If you select button with number 4 and navigate right, the buttons
+   * will be navigated in the following order 4->5->6.
+   * The flow is maintained for the Y axis while you're navigating the X axis.
+   */
   MAINTAIN_Y,
+
+  /**
+   * Give focus to the first child element with `preferredFocus == true` prop.
+   */
   PREFERRED_CHILD,
 }
 export interface GamepadEventDetail {
@@ -48,6 +79,25 @@ export declare type ActionDescriptionMap = {
 };
 export declare type GamepadEvent = CustomEvent<GamepadEventDetail>;
 export interface FooterLegendProps {
+  /**
+   * Navigation entry strategy to be used when gaining focus during navigation.
+   * 
+   * This is meant to be used on a parent container that has children. Once the
+   * container (e.g. Focusable) is navigated to and has children in it, the children
+   * is then navigated to (focused) using the provided strategy.
+   * 
+   * If no strategy is provided, it seems that the `NavEntryPositionPreferences.FIRST`
+   * is used initialy, but for the next time the parent remembers previously focused
+   * child and focused back on it instead.
+   */
+  navEntryPreferPosition?: NavEntryPositionPreferences;
+
+  /**
+   * Mark the element as the preferred child (to be focused) whenever the parent uses the
+   * `NavEntryPositionPreferences.PREFERRED_CHILD` navigation strategy.
+   */
+  preferredFocus?: boolean;
+
   actionDescriptionMap?: ActionDescriptionMap;
   onOKActionDescription?: ReactNode;
   onCancelActionDescription?: ReactNode;

package/src/utils/index.ts

@@ -25,7 +25,7 @@ export function findSP(): Window {
   if (document.title == 'SP') return window;
   // new (SP as popup)
   const navTrees = getGamepadNavigationTrees();
-  return navTrees?.find((x: any) => x.m_ID == 'root_1_')?.Root?.Element?.ownerDocument?.defaultView;
+  return navTrees?.find((x: any) => x.m_ID == 'GamepadUI_Full_Root' || x.m_ID == 'root_1_')?.Root?.Element?.ownerDocument?.defaultView;
 }
 
 /**