Skip to content

Commit

Permalink
Added JSDoc comments for the DataGrid component to document its props…
Browse files Browse the repository at this point in the history
… and functionality.
  • Loading branch information
AkshatGupta15 committed Oct 11, 2024
1 parent 3cdfb2c commit d645b29
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions components/DataGrid/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ interface paramsType {
isVisibleToRole102?: boolean;
}

/**
* DataGrid component for rendering a data grid with customizable rows, columns, and various options.
*
* @param {Object} props - The properties object.
* @param {Array} props.rows - The data rows to be displayed in the grid.
* @param {Array} props.columns - The column definitions for the grid.
* @param {Function} props.onCellClick - Callback function to handle cell click events.
* @param {Function} props.getRowId - Function to get the unique identifier for each row.
* @param {boolean} [props.loading=false] - Flag to indicate if the grid is in a loading state.
* @param {boolean} [props.heighted=false] - Flag to control the auto height behavior of the grid.
* @param {boolean} [props.isVisibleToRole102=false] - Flag to control visibility of certain toolbar options for role 102.
*
* @returns {JSX.Element} The rendered data grid component.
*/
function Index({
rows,
columns,
Expand Down

0 comments on commit d645b29

Please sign in to comment.