Typedoc comment

Author: jeevasusej

src/TableAdapter.tsx

@@ -230,7 +230,26 @@ const ExpandedRow = React.memo(
     );
   }
 );
-
+/**
+ * TableAdapter - A comprehensive wrapper around TanStack Table v8.0.0
+ *
+ * Provides a simplified API with extensive customization options while
+ * leveraging TanStack Table's powerful core functionality.
+ *
+ * @template TData - The type of data being displayed in the table
+ * @template TValue - The type of values in the table cells
+ *
+ * @example
+ * ```tsx
+ * <TableAdapter
+ *   data={users}
+ *   columns={[
+ *     { accessorKey: 'name', header: 'Name' },
+ *     { accessorKey: 'email', header: 'Email' },
+ *   ]}
+ * />
+ * ```
+ */
 export function TableAdapter<TData extends object, TValue = unknown>(
   props: TableAdapterProps<TData, TValue>
 ) {

src/TableConfigContext.tsx

@@ -13,8 +13,14 @@ import { DEFAULT_TABLE_CLASSNAMES, mergeClassNames } from "./utils";
 const TableConfigContext = createContext<TableConfig | undefined>(undefined);
 
 /**
- * Provider component for table configuration
- * Manages global styling defaults for all TableAdapter instances
+ * Provider component for global table configuration
+ *
+ * Manages global styling defaults for all TableAdapter instances.
+ * Wrap your application or a section of it with this provider to
+ * establish consistent table styling across components.
+ *
+ * @param props.children - Child components
+ * @param props.initialClassNames - Initial class name overrides
  */
 export function TableConfigProvider({
   children,
@@ -64,9 +70,10 @@ export function TableConfigProvider({
 }
 
 /**
- * Hook to use the table configuration
- * @returns The table configuration from context
- * @throws Error if used outside of a TableConfigProvider
+ * Hook to access the table configuration context
+ *
+ * @returns The table configuration context
+ * @throws Error if used outside of TableConfigProvider
  */
 export function useTableConfig(): TableConfig {
   const context = useContext(TableConfigContext);

src/TableWithLoadingStates.tsx

@@ -4,9 +4,22 @@ import {
   EnhancedPaginationLoadingComponent,
 } from "./components";
 
+// For TableWithLoadingStates
 /**
- * TableWithLoadingStates - A wrapper component that manages loading states for TableAdapter
- * This separates loading UI concerns from the table component itself
+ * Wrapper component that manages loading states for TableAdapter
+ *
+ * This component separates loading UI concerns from the table component itself,
+ * providing a clean way to handle initial loading and pagination loading states.
+ *
+ * @example
+ * ```tsx
+ * <TableWithLoadingStates
+ *   isInitialLoading={isLoading}
+ *   isPaginationLoading={isPaginating}
+ * >
+ *   <TableAdapter data={data} columns={columns} />
+ * </TableWithLoadingStates>
+ * ```
  */
 export function TableWithLoadingStates({
   isInitialLoading = false,

src/hooks.ts

@@ -14,7 +14,19 @@ import {
 import { createControlledHandler, exportToCSV } from "./utils";
 import { TableAdapterProps, TableExportOptions, TableServer } from "./types";
 
-// Custom hook for managed table state with controlled/uncontrolled pattern
+// For the custom hooks
+/**
+ * Custom hook for managing table state with controlled/uncontrolled pattern
+ *
+ * Handles all table state (sorting, pagination, filtering, etc.) and
+ * properly manages the controlled vs. uncontrolled state.
+ *
+ * @template TData - The type of data being displayed in the table
+ * @template TValue - The type of values in the table cells
+ *
+ * @param props - The TableAdapter props
+ * @returns Object containing current state values and handler functions
+ */
 export function useTableState<TData extends object, TValue = unknown>(
   props: TableAdapterProps<TData, TValue>
 ) {
@@ -271,7 +283,19 @@ export function useTableState<TData extends object, TValue = unknown>(
   };
 }
 
-// Custom hook for server-side data fetching
+/**
+ * Custom hook for server-side data fetching
+ *
+ * Manages loading states, error handling, and data fetching based on
+ * table state changes (pagination, sorting, filtering).
+ *
+ * @template TData - The type of data being displayed in the table
+ *
+ * @param table - The TanStack Table instance
+ * @param serverOptions - Server-side options for data fetching
+ * @param onError - Optional error handler
+ * @returns Object containing loading state, data, and error information
+ */
 export function useServerSideData<TData extends object>(
   table: Table<TData>,
   serverOptions?: TableServer,
@@ -358,7 +382,19 @@ export function useServerSideData<TData extends object>(
   };
 }
 
-// Custom hook for CSV/Excel export functionality
+/**
+ * Custom hook for CSV/Excel/JSON export functionality
+ *
+ * Provides methods to export table data in various formats.
+ *
+ * @template TData - The type of data being displayed in the table
+ * @template TValue - The type of values in the table cells
+ *
+ * @param data - The data to export
+ * @param columns - The table columns
+ * @param options - Export options (format, filename, etc.)
+ * @returns Object containing export functions
+ */
 export function useTableExport<TData extends object, TValue = unknown>(
   data: TData[],
   columns: ColumnDef<TData, TValue>[],
@@ -433,7 +469,18 @@ export function useTableExport<TData extends object, TValue = unknown>(
   };
 }
 
-// Custom hook for form integration
+/**
+ * Custom hook for form integration with tables
+ *
+ * Enables editing table data with validation and form submission.
+ *
+ * @template TData - The type of data being displayed in the table
+ *
+ * @param initialData - The initial form data
+ * @param onSubmit - Form submission handler
+ * @param validationRules - Validation rules for form fields
+ * @returns Object containing form state and handlers
+ */
 export function useTableForm<TData extends object>(
   initialData: TData[],
   onSubmit?: (data: TData[]) => void,

src/test-utils.tsx

@@ -4,9 +4,27 @@ import userEvent from "@testing-library/user-event";
 import { TableAdapter } from "./index";
 import type { TableAdapterProps } from "./types";
 
+// For test utilities
 /**
  * Creates a test table with default test data and columns
- * This is useful for unit testing components that use TableAdapter
+ *
+ * This utility function is designed for unit testing components that use TableAdapter.
+ * It provides helper methods to interact with and assert against the rendered table.
+ *
+ * @template TData - The type of data being displayed in the table
+ *
+ * @param props - Partial TableAdapter props to override defaults
+ * @returns Object containing render result and helper functions
+ *
+ * @example
+ * ```tsx
+ * test('sorts table when clicking header', async () => {
+ *   const { sortByColumn, getCellContent } = createTestTable();
+ *
+ *   await sortByColumn('Name');
+ *   expect(getCellContent(0, 1)).toBe('Test 1');
+ * });
+ * ```
  */
 export function createTestTable<TData extends object>(
   props: Partial<TableAdapterProps<TData>> = {}