refactor(useSortableColumns): implement types (carbon-design-system#5464

)
amal-k-joy · Jun 12, 2024 · fef7d25 · fef7d25
1 parent 553f2c7
commit fef7d25
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/packages/ibm-products/src/components/Datagrid/types/index.ts b/packages/ibm-products/src/components/Datagrid/types/index.ts
@@ -264,6 +264,7 @@ export interface DataGridState<T extends object = any>
   onVirtualScroll?: (evt?: boolean) => void;
   fetchMoreData?: () => void;
   loadMoreThreshold?: number;
+  onSort?: boolean;
 }
 
 // DatagridHeaderRow related types

diff --git a/...components/Datagrid/useSortableColumns.js → ...omponents/Datagrid/useSortableColumns.tsx b/...components/Datagrid/useSortableColumns.js → ...omponents/Datagrid/useSortableColumns.tsx
@@ -12,6 +12,8 @@ import { Button } from '@carbon/react';
 import { ArrowUp, ArrowDown, ArrowsVertical } from '@carbon/react/icons';
 import { SelectAll } from './Datagrid/DatagridSelectAll';
 import { DatagridSlug } from './Datagrid/addons/Slug/DatagridSlug';
+import { Hooks, TableInstance } from 'react-table';
+import { DataGridState } from './types';
 
 const blockClass = `${pkg.prefix}--datagrid`;
 
@@ -21,9 +23,9 @@ const ordering = {
   NONE: 'NONE',
 };
 
-export const getNewSortOrder = (sortOrder) => {
+export const getNewSortOrder = (sortOrder?: boolean | string) => {
   const order = {
-    newSortDesc: undefined,
+    newSortDesc: false,
     newOrder: ordering.NONE,
   };
   if (sortOrder === false || sortOrder === ordering.DESC) {
@@ -71,7 +73,7 @@ const getAriaPressedValue = (col) => {
   return 'false';
 };
 
-const useSortableColumns = (hooks) => {
+const useSortableColumns = (hooks: Hooks) => {
   const sortableVisibleColumns = (visibleColumns, { instance }) => {
     const {
       onSort,
@@ -171,8 +173,8 @@ const useSortableColumns = (hooks) => {
       : [...sortableColumns];
   };
 
-  const sortInstanceProps = (instance) => {
-    const { onSort } = instance;
+  const sortInstanceProps = (instance: TableInstance) => {
+    const { onSort } = instance as DataGridState;
     Object.assign(instance, { manualSortBy: !!onSort, isTableSortable: true });
   };