Deprecate nativeMode (#220)

* Deprecate nativeMode option in SpatialNavigation; update documentation and add warning for removal in next version.

* ci: update Node.js version in workflows to 24

* Create changeset

* ci: upgrade actions/checkout and actions/setup-node to v6 in workflows

* ci: remove npm update step

Author: xavi160

.changeset/slimy-spoons-kick.md

@@ -0,0 +1,5 @@
+---
+"@noriginmedia/norigin-spatial-navigation-core": patch
+---
+
+- Deprecate `nativeMode` option

.github/workflows/dev-portal.yml

@@ -12,12 +12,12 @@ jobs:
 
     steps:
       - name: Checkout Project A
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
         with:
           path: ./project
 
       - name: Checkout Project B
-        uses: actions/checkout@master
+        uses: actions/checkout@v6
         with:
           repository: Norigin/dev-portal
           token: ${{ secrets.NM_GH_TOKEN }}

.github/workflows/pull-request.yml

@@ -8,12 +8,12 @@ jobs:
     name: Test
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
-          node-version: 22
+          node-version: 24
           cache: npm
 
       - name: Install dependencies

.github/workflows/release.yml

@@ -17,17 +17,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - name: Setup Node.js 22
-        uses: actions/setup-node@v4
+      - name: Setup Node
+        uses: actions/setup-node@v6
         with:
-          node-version: 22
+          node-version: 24
           cache: npm
 
-      - name: Update npm for OICD support
-        run: npm install -g npm@latest
-
       - name: Install Dependencies
         run: npm ci
 

docs/api-reference/SpatialNavigation.md

@@ -62,7 +62,7 @@ init(config?: {
 | ----------------------------------- | ---------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |
 | `debug`                             | `boolean`                          | `false`     | Log navigation decisions to the browser console.                                                                                        |
 | `visualDebug`                       | `boolean`                          | `false`     | Draw a canvas overlay showing component bounding boxes and navigation paths.                                                            |
-| `nativeMode`                        | `boolean`                          | `false`     | Disable DOM key event listeners (for React Native). You must drive navigation manually.                                                 |
+| `nativeMode`                        | `boolean`                          | `false`     | **Deprecated.** Disable DOM key event listeners (for React Native). You must drive navigation manually.                                 |
 | `throttle`                          | `number`                           | `0`         | Milliseconds to wait between processing repeated key presses. `0` means no throttle.                                                    |
 | `throttleKeypresses`                | `boolean`                          | `false`     | When `true` and `throttle > 0`, throttle key repeat events while a key is held down.                                                    |
 | `useGetBoundingClientRect`          | `boolean`                          | `false`     | Use `getBoundingClientRect()` instead of `offsetLeft/Top` for layout measurement. Use this when elements are CSS-transformed or scaled. |

packages/core/src/SpatialNavigation.ts

@@ -663,6 +663,10 @@ class SpatialNavigationService {
   init({
     debug = false,
     visualDebug = false,
+    /**
+     * @deprecated
+     * Native mode will be removed in the next version
+     */
     nativeMode = false,
     throttle: throttleParam = 0,
     throttleKeypresses = false,
@@ -712,6 +716,10 @@ class SpatialNavigationService {
 
           draw();
         }
+      } else {
+        console.warn(
+          'nativeMode option is deprecated and will be removed in the next version.'
+        );
       }
     }
   }
@@ -1765,6 +1773,10 @@ class SpatialNavigationService {
     }
   }
 
+  /**
+   * @deprecated
+   * Native mode will be removed in the next version
+   */
   isNativeMode() {
     return this.nativeMode;
   }