More updates

Author: amanmahajan7

README.md

@@ -113,7 +113,7 @@ Rows pinned at the bottom of the grid for summary purposes.
 
 ###### `rowKeyGetter?: Maybe<(row: R) => K>`
 
-A function returning a unique key/identifier per row. `rowKeyGetter` is required for row selection to work.
+Function to return a unique key/identifier for each row. `rowKeyGetter` is required for row selection to work.
 
 ```tsx
 import { DataGrid } from 'react-data-grid';
@@ -136,7 +136,8 @@ function MyGrid() {
 
 ###### `onRowsChange?: Maybe<(rows: R[], data: RowsChangeData<R, SR>) => void>`
 
-A function receiving row updates.
+Callback triggered when rows are updated.
+
 The first parameter is a new rows array with both the updated rows and the other untouched rows.
 The second parameter is an object with an `indexes` array highlighting which rows have changed by their index, and the `column` where the change happened.
 
@@ -155,7 +156,7 @@ function MyGrid() {
 
 **Default:** `35` pixels
 
-Either a number defining the height of row in pixels, or a function returning dynamic row heights.
+Height of each row in pixels. A function can be used to set different row heights.
 
 ###### `headerRowHeight?: Maybe<number>`
 
@@ -175,11 +176,11 @@ A set of selected row keys. `rowKeyGetter` is required for row selection to work
 
 ###### `isRowSelectionDisabled?: Maybe<(row: NoInfer<R>) => boolean>`
 
-A function used to disable row selection on certain rows.
+Function to determine if row selection is disabled for a specific row.
 
 ###### `onSelectedRowsChange?: Maybe<(selectedRows: Set<K>) => void>`
 
-A function called when row selection is changed.
+Function called whenever row selection is changed.
 
 ```tsx
 import { useState } from 'react';
@@ -218,11 +219,11 @@ function isRowSelectionDisabled(row: Row) {
 
 ###### `sortColumns?: Maybe<readonly SortColumn[]>`
 
-An array of sorted columns.
+An array of sorted columns. Sorting can be done on multiple columns.
 
 ###### `onSortColumnsChange?: Maybe<(sortColumns: SortColumn[]) => void>`
 
-A function called when sorting is changed.
+Callback triggered when sorting changes.
 
 ```tsx
 import { useState } from 'react';
@@ -286,7 +287,7 @@ function MyGrid() {
 
 ###### `onCellClick?: Maybe<(args: CellClickArgs<R, SR>, event: CellMouseEvent) => void>`
 
-Triggered when a cell is clicked. The default behavior is to select the cell. Call `preventGridDefault` to prevent the default behavior
+Callback triggered when a cell is clicked. The default behavior is to select the cell. Call `preventGridDefault` to prevent the default behavior
 
 ```tsx
 function onCellClick(args: CellClickArgs<R, SR>, event: CellMouseEvent) {
@@ -677,7 +678,7 @@ Enables cell editing. If set and no editor property specified, then a textinput
 
 **Default**: `false`
 
-Determines whether column is frozen. Frozem columns are pinned on th left. At the moment
+Determines whether column is frozen. Frozen columns are pinned on the left. At the moment we do not support pinning columns on the right.
 
 ##### `resizable?: Maybe<boolean>`
 

src/DataGrid.tsx

@@ -132,83 +132,85 @@ export interface DataGridProps<R, SR = unknown, K extends Key = Key> extends Sha
   columns: readonly ColumnOrColumnGroup<NoInfer<R>, NoInfer<SR>>[];
   /** A function called for each rendered row that should return a plain key/value pair object */
   rows: readonly R[];
-  /**
-   * Rows to be pinned at the top of the rows view for summary, the vertical scroll bar will not scroll these rows.
-   */
+  /** Rows pinned at the top of the grid for summary purposes */
   topSummaryRows?: Maybe<readonly SR[]>;
-  /**
-   * Rows to be pinned at the bottom of the rows view for summary, the vertical scroll bar will not scroll these rows.
-   */
+  /** Rows pinned at the bottom of the grid for summary purposes */
   bottomSummaryRows?: Maybe<readonly SR[]>;
-  /** The getter should return a unique key for each row */
+  /** Function to return a unique key/identifier for each row */
   rowKeyGetter?: Maybe<(row: NoInfer<R>) => K>;
+  /** Callback triggered when rows are updated */
   onRowsChange?: Maybe<(rows: NoInfer<R>[], data: RowsChangeData<NoInfer<R>, NoInfer<SR>>) => void>;
 
   /**
    * Dimensions props
    */
   /**
-   * The height of each row in pixels
+   * Height of each row in pixels
    * @default 35
    */
   rowHeight?: Maybe<number | ((row: NoInfer<R>) => number)>;
   /**
-   * The height of the header row in pixels
+   * Height of the header row in pixels
    * @default 35
    */
   headerRowHeight?: Maybe<number>;
   /**
-   * The height of each summary row in pixels
+   * Height of each summary row in pixels
    * @default 35
    */
   summaryRowHeight?: Maybe<number>;
 
   /**
    * Feature props
    */
-  /** Set of selected row keys */
+  /** A set of selected row keys */
   selectedRows?: Maybe<ReadonlySet<K>>;
-  /** Determines if row selection is disabled, per row */
+  /** Function to determine if row selection is disabled for a specific row */
   isRowSelectionDisabled?: Maybe<(row: NoInfer<R>) => boolean>;
   /** Function called whenever row selection is changed */
   onSelectedRowsChange?: Maybe<(selectedRows: Set<NoInfer<K>>) => void>;
-  /** Used for multi column sorting */
+  /** An array of sorted columns */
   sortColumns?: Maybe<readonly SortColumn[]>;
+  /** Callback triggered when sorting changes */
   onSortColumnsChange?: Maybe<(sortColumns: SortColumn[]) => void>;
+  /** Default options applied to all columns */
   defaultColumnOptions?: Maybe<DefaultColumnOptions<NoInfer<R>, NoInfer<SR>>>;
   onFill?: Maybe<(event: FillEvent<NoInfer<R>>) => NoInfer<R>>;
 
   /**
    * Event props
    */
-  /** Function called whenever a cell is clicked */
+  /** Callback triggered when a cell is clicked */
   onCellClick?: Maybe<
     (args: CellClickArgs<NoInfer<R>, NoInfer<SR>>, event: CellMouseEvent) => void
   >;
-  /** Function called whenever a cell is double clicked */
+  /** Callback triggered when a cell is double-clicked */
   onCellDoubleClick?: Maybe<
     (args: CellClickArgs<NoInfer<R>, NoInfer<SR>>, event: CellMouseEvent) => void
   >;
-  /** Function called whenever a cell is right clicked */
+  /** Callback triggered when a cell is right-clicked */
   onCellContextMenu?: Maybe<
     (args: CellClickArgs<NoInfer<R>, NoInfer<SR>>, event: CellMouseEvent) => void
   >;
+  /** Callback triggered when a key is pressed in a cell */
   onCellKeyDown?: Maybe<
     (args: CellKeyDownArgs<NoInfer<R>, NoInfer<SR>>, event: CellKeyboardEvent) => void
   >;
+  /** Callback triggered when a cell's content is copied */
   onCellCopy?: Maybe<
     (args: CellCopyEvent<NoInfer<R>, NoInfer<SR>>, event: CellClipboardEvent) => void
   >;
+  /** Callback triggered when content is pasted into a cell */
   onCellPaste?: Maybe<
     (args: CellPasteEvent<NoInfer<R>, NoInfer<SR>>, event: CellClipboardEvent) => NoInfer<R>
   >;
   /** Function called whenever cell selection is changed */
   onSelectedCellChange?: Maybe<(args: CellSelectArgs<NoInfer<R>, NoInfer<SR>>) => void>;
-  /** Called when the grid is scrolled */
+  /** Callback triggered when the grid is scrolled */
   onScroll?: Maybe<(event: React.UIEvent<HTMLDivElement>) => void>;
-  /** Called when a column is resized */
+  /** Callback triggered when column is resized */
   onColumnResize?: Maybe<(column: CalculatedColumn<R, SR>, width: number) => void>;
-  /** Called when a column is reordered */
+  /** Callback triggered when columns are reordered */
   onColumnsReorder?: Maybe<(sourceColumnKey: string, targetColumnKey: string) => void>;
 
   /**
@@ -220,10 +222,16 @@ export interface DataGridProps<R, SR = unknown, K extends Key = Key> extends Sha
   /**
    * Miscellaneous
    */
+  /** Custom renderers for cells, rows, and other components */
   renderers?: Maybe<Renderers<NoInfer<R>, NoInfer<SR>>>;
+  /** Function to apply custom class names to rows */
   rowClass?: Maybe<(row: NoInfer<R>, rowIdx: number) => Maybe<string>>;
+  /** Custom class name for the header row */
   headerRowClass?: Maybe<string>;
-  /** @default 'ltr' */
+  /**
+   * Text direction of the grid ('ltr' or 'rtl')
+   * @default 'ltr'
+   * */
   direction?: Maybe<Direction>;
   'data-testid'?: Maybe<string>;
   'data-cy'?: Maybe<string>;