refactor: deprecate positional navigateTo signature (#82)

Deprecate the positional `navigateTo(row, column?, activate?)`
signature in favor of the new `navigateTo(row, options)` signature,
instead of an outright breaking change.

Author: rkaraivanov

CHANGELOG.md

@@ -15,9 +15,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Keyboard navigation and click activation set DOM focus on the active cell. Screen readers announce the cell. [#79](https://github.com/IgniteUI/igniteui-grid-lite/pull/79)
 - Public `columns` setter. [#78](https://github.com/IgniteUI/igniteui-grid-lite/pull/78)
 
+### Deprecated
+
+- The positional `navigateTo(row, column?, activate?)` arguments. Use `navigateTo(row, options)` instead. [#79](https://github.com/IgniteUI/igniteui-grid-lite/pull/79)
+
 ### Changed
 
-- **BREAKING:** `navigateTo(row, options)` replaces the positional `navigateTo(row, column?, activate?)` arguments. Navigation without a column keeps the current column. [#79](https://github.com/IgniteUI/igniteui-grid-lite/pull/79)
+- Navigation without a column keeps the current column. [#79](https://github.com/IgniteUI/igniteui-grid-lite/pull/79)
 - Cell activation updates only the two affected rows, not all visible rows. [#79](https://github.com/IgniteUI/igniteui-grid-lite/pull/79)
 - Faster rendering: rows reuse cells across column changes, sorting shares one collator, and a `ResizeObserver` drives the scrollbar offset. [#78](https://github.com/IgniteUI/igniteui-grid-lite/pull/78)
 

src/components/grid.ts

@@ -492,7 +492,24 @@ export class IgcGridLite<T extends object = any> extends EventEmitterBase<IgcGri
    * @param row The row index to navigate to
    * @param options The column field to navigate to and whether to activate the cell
    */
-  public async navigateTo(row: number, options?: NavigateToOptions<T>) {
+  public async navigateTo(row: number, options?: NavigateToOptions<T>): Promise<void>;
+  /**
+   * Navigates to a position in the grid based on provided row index and column field.
+   * @param row The row index to navigate to
+   * @param column The column field to navigate to, if any
+   * @param activate Optionally also activate the navigated cell
+   * @deprecated Use `navigateTo(row, options)` instead.
+   */
+  public async navigateTo(row: number, column?: Keys<T>, activate?: boolean): Promise<void>;
+  public async navigateTo(
+    row: number,
+    columnOrOptions?: Keys<T> | NavigateToOptions<T>,
+    activate?: boolean
+  ): Promise<void> {
+    // Normalize the deprecated positional form into options.
+    const options =
+      typeof columnOrOptions === 'object' ? columnOrOptions : { column: columnOrOptions, activate };
+
     await this._stateController.navigation.navigateTo(row, options);
   }
 

test/activation.test.ts

@@ -290,5 +290,19 @@ describe('Grid activation', () => {
       expect(cell.active).to.be.true;
       expect(isVisibleGrid(cell.element)).to.be.true;
     });
+
+    it('supports the deprecated positional signature', async () => {
+      await TDD.grid.navigateTo(1, 'name');
+
+      let cell = TDD.rows.get(1).cells.get('name');
+      expect(cell.active).to.be.false;
+      expect(isVisibleGrid(cell.element)).to.be.true;
+
+      await TDD.grid.navigateTo(2, 'id', true);
+
+      cell = TDD.rows.get(2).cells.get('id');
+      expect(cell.active).to.be.true;
+      expect(isVisibleGrid(cell.element)).to.be.true;
+    });
   });
 });