From 31ea57542b36dc0ac13ab350a95db7f33a760dfa Mon Sep 17 00:00:00 2001 From: Daniel Cojocea Date: Mon, 19 Aug 2024 19:08:43 -0400 Subject: [PATCH] Added docs --- Client/src/Components/BasicTable/index.jsx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Client/src/Components/BasicTable/index.jsx b/Client/src/Components/BasicTable/index.jsx index 37bc73d85..09e8f5936 100644 --- a/Client/src/Components/BasicTable/index.jsx +++ b/Client/src/Components/BasicTable/index.jsx @@ -21,6 +21,18 @@ import SelectorVertical from "../../assets/icons/selector-vertical.svg?react"; import Button from "../Button"; import "./index.css"; +/** + * Component for pagination actions (first, previous, next, last). + * + * @component + * @param {Object} props + * @param {number} props.count - Total number of items. + * @param {number} props.page - Current page number. + * @param {number} props.rowsPerPage - Number of rows per page. + * @param {function} props.onPageChange - Callback function to handle page change. + * + * @returns {JSX.Element} Pagination actions component. + */ const TablePaginationActions = (props) => { const { count, page, rowsPerPage, onPageChange } = props; @@ -160,6 +172,10 @@ const BasicTable = ({ data, paginated, reversed, rows = 5 }) => { return
No data
; } + /** + * Helper function to calculate the range of displayed rows. + * @returns {string} + */ const getRange = () => { let start = page * rowsPerPage + 1; let end = Math.min(page * rowsPerPage + rowsPerPage, data.rows.length);