@solostylist/ui-kit 1.0.166 → 1.0.168

package/dist/s-data-table/s-data-table.d.ts

@@ -1,8 +1,7 @@
 import { TableProps } from '@mui/material/Table';
 import * as React from 'react';
 /**
- * Column definition interface for data table columns
- * Defines how data should be displayed and formatted in table columns
+ * Column definition interface for SDataTable component
  */
 export interface ColumnDef<TRowModel> {
     /** Text alignment for column content and header */
@@ -21,7 +20,7 @@ export interface ColumnDef<TRowModel> {
 /** Type for row identification - can be number or string */
 type RowId = number | string;
 /**
- * Props for the SDataTable component, extending Material-UI TableProps
+ * Props interface for SDataTable component
  */
 export interface SDataTableProps<TRowModel> extends Omit<TableProps, 'onClick'> {
     /** Array of column definitions specifying how to display data */
@@ -50,67 +49,12 @@ export interface SDataTableProps<TRowModel> extends Omit<TableProps, 'onClick'>
     uniqueRowId?: (row: TRowModel) => RowId;
 }
 /**
- * Advanced data table component with selection, sorting, and customizable columns
- *
- * Features:
- * - Flexible column definitions with custom formatting
- * - Row selection with checkboxes (individual and bulk)
- * - Clickable rows with hover effects
- * - Empty state handling
- * - Hidden header option
- * - Customizable column alignment and width
- * - Generic type support for type-safe row data
- *
- * The table expects row data to optionally have an 'id' field, or you can provide
- * a custom uniqueRowId function to extract identifiers from your data structure.
- *
- * @param columns - Array defining how each column should be displayed
- * @param hideHead - Whether to hide the table header row
- * @param hover - Whether rows should show hover effects
- * @param onClick - Handler for row click events
- * @param onDeselectAll - Handler for bulk deselection
- * @param onDeselectOne - Handler for individual row deselection
- * @param onSelectOne - Handler for individual row selection
- * @param onSelectAll - Handler for bulk selection
- * @param rows - Array of data objects to display
- * @param selectable - Whether to show selection checkboxes
- * @param selected - Set of currently selected row IDs
- * @param uniqueRowId - Function to extract unique ID from row data
- * @param props - Additional Material-UI Table props
- * @returns JSX element containing the complete data table
- *
- * @example
- * ```tsx
- * interface User {
- *   id: number;
- *   name: string;
- *   email: string;
- *   role: string;
- * }
- *
- * const columns: ColumnDef<User>[] = [
- *   { name: 'Name', field: 'name' },
- *   { name: 'Email', field: 'email' },
- *   {
- *     name: 'Actions',
- *     formatter: (user) => (
- *       <Button onClick={() => editUser(user.id)}>Edit</Button>
- *     )
- *   }
- * ];
- *
- * <SDataTable
- *   columns={columns}
- *   rows={users}
- *   selectable
- *   selected={selectedUsers}
- *   onSelectOne={handleSelectUser}
- *   onSelectAll={handleSelectAll}
- *   onClick={handleRowClick}
- * />
- * ```
+ * An advanced data table component with row selection, custom column formatting, and empty state handling.
  */
-declare function SDataTable<TRowModel extends object & {
-    id?: RowId | null;
-}>({ columns, hideHead, hover, onClick, onDeselectAll, onDeselectOne, onSelectOne, onSelectAll, rows, selectable, selected, uniqueRowId, ...props }: SDataTableProps<TRowModel>): React.JSX.Element;
+export declare const SDataTable: {
+    <TRowModel extends object & {
+        id?: RowId | null;
+    }>({ columns, hideHead, hover, onClick, onDeselectAll, onDeselectOne, onSelectOne, onSelectAll, rows, selectable, selected, uniqueRowId, ...props }: SDataTableProps<TRowModel>): React.JSX.Element;
+    displayName: string;
+};
 export default SDataTable;