react-base-data-table 0.5.7 → 0.5.9

package/README.md

@@ -1,6 +1,8 @@
 # @redevilkz/react-base-table
 
-A simple, customizable, and extensible React table component with support for sorting, filtering, grouping, row highlighting, custom rendering, drag-and-drop, and context menus.
+A simple, customizable, and extensible React table component with support for sorting, filtering, grouping, row highlighting, custom rendering, drag-and-drop, collaboration, and context menus.
+
+> 📖 **A detailed documentation website is coming soon!**
 
 ---
 
@@ -13,32 +15,23 @@ A simple, customizable, and extensible React table component with support for so
 - **Custom Rendering**: Render custom content in headers and cells.
 - **Drag & Drop**: Reorder rows with drag-and-drop (optional).
 - **Context Menu**: Right-click on cells to open a customizable context menu.
-- **Row Actions**: Double-click, right-click, and other row/cell interactions.
-- **Responsive & Scrollable**: Pin columns, set table height, and enable horizontal scrolling.
+- **Collaboration**: Real-time multi-user cell selection display.
+- **Comments**: Add comments to cells.
+- **Inline Editing**: Edit cell values directly in the table.
 - **Theming**: Easily style with Tailwind and DaisyUI classes.
 
 ---
 
 ## Installation
 
-Install the package via npm or yarn:
-
 ```bash
 npm install react-base-data-table
 ```
 
-or
-
-```bash
-yarn add react-base-data-table
-```
-
 ---
 
 ## Usage
 
-Import the `BaseTable` component and its CSS:
-
 ```javascript
 import { BaseTable } from "react-base-data-table";
 ```
@@ -47,13 +40,13 @@ import { BaseTable } from "react-base-data-table";
 
 ```jsx
 const headers = [
-  { id: "name", text: "Name", type: "string", sortable: true },
-  { id: "age", text: "Age", type: "number", sortable: true },
+  { id: "name", text: "Name", sortable: true },
+  { id: "age", text: "Age", sortable: true },
 ];
 
 const items = [
-  { name: "John Doe", age: "30" },
-  { name: "Jane Smith", age: "25" },
+  { name: "John Doe", age: 30 },
+  { name: "Jane Smith", age: 25 },
 ];
 
 <BaseTable headers={headers} items={items} />;
@@ -65,247 +58,106 @@ const items = [
 
 ### `BaseTableProps`
 
-| Prop                    | Type                                                             | Default | Description                                |
-| ----------------------- | ---------------------------------------------------------------- | ------- | ------------------------------------------ |
-| `height`                | `string`                                                         | `auto`  | Sets the height of the table.              |
-| `headers`               | `BaseTableHeader[]`                                              | -       | Defines the headers of the table.          |
-| `items`                 | `TableItem[]`                                                    | -       | Data items to display in the table.        |
-| `marginTop`             | `string`                                                         | `0`     | Top margin for the table.                  |
-| `noBorder`              | `boolean`                                                        | `false` | Removes the border around the table.       |
-| `pinColumns`            | `boolean`                                                        | `false` | Pins columns for horizontal scrolling.     |
-| `alignCenterInLine`     | `boolean`                                                        | `false` | Centers content within rows.               |
-| `currentSortId`         | `string`                                                         | -       | ID of the column currently being sorted.   |
-| `highlightCondition`    | `{ propertyId: string, value: unknown, style: CSSProperties }[]` | -       | Conditions for highlighting rows.          |
-| `onResetSort`           | `() => void`                                                     | -       | Callback to reset sorting.                 |
-| `onRowDoubleClick`      | `(item: TableItem) => void`                                      | -       | Callback for double-clicking a row.        |
-| `onSortByColumn`        | `(columnId: string) => void`                                     | -       | Callback for sorting by a column.          |
-| `showIndex`             | `boolean`                                                        | `false` | Shows an index column.                     |
-| `indexUseOriginalOrder` | `boolean`                                                        | `false` | Uses original item order for index column. |
-| `contrastRow`           | `boolean`                                                        | `false` | Alternates row background for contrast.    |
-| `activeFilters`         | `ActiveTableFilter[]`                                            | -       | Active filters for columns.                |
-| `groupBy`               | `string`                                                         | -       | Groups rows by this column ID.             |
-| `currentUsername`       | `string`                                                         | -       | Pass current user for custom logic.        |
-| `comments`              | `CommentData[]`                                                  | -       | Comments to display in the table.          |
+| Prop                         | Type                                               | Description                                               |
+| ---------------------------- | -------------------------------------------------- | --------------------------------------------------------- |
+| `headers`                    | `BaseTableHeader[]`                                | Column definitions for the table (required).              |
+| `items`                      | `TableItem[]`                                      | Data items to display (required).                         |
+| `height`                     | `string`                                           | Table height.                                             |
+| `advancedSettings`           | `AdvancedTableSettings`                            | Additional table configuration options.                   |
+| `highlightCondition`         | `HighlightCondition[]`                             | Conditions for highlighting rows/cells.                   |
+| `comments`                   | `CommentData[]`                                    | Comments data for cells.                                  |
+| `activeFilters`              | `ActiveTableFilter[]`                              | Active column filters.                                    |
+| `groupBy`                    | `string`                                           | Column ID to group rows by.                               |
+| `linkedGroups`               | `LinkedGroup[]`                                    | Configuration for linked group behavior.                  |
+| `collaboration`              | `CollaborationConfig`                              | Real-time collaboration settings.                         |
+| `onUserSelectionChange`      | `(data: UserSelectionData) => void`                | Callback when user selection changes (for collaboration). |
+| `onSetHighlightCondition`    | `(condition, item) => void`                        | Callback to set highlight condition.                      |
+| `onRemoveHighlightCondition` | `(condition, cssProperty, item) => void`           | Callback to remove highlight condition.                   |
+| `onSaveComment`              | `(comment, item) => void`                          | Callback when a comment is saved.                         |
+| `onDeleteComment`            | `(comment, item) => void`                          | Callback when a comment is deleted.                       |
+| `onChange`                   | `(itemUpdated, originalIndex, fromArray?) => void` | Callback when a cell value changes.                       |
+| `onBulkChange`               | `(items, headerId?) => void`                       | Callback for bulk cell changes.                           |
+| `onBulkFieldChange`          | `(items, headerId) => void`                        | Callback for bulk field changes on a column.              |
+| `groupByCustomRender`        | `(groupBy, value, ...) => ReactNode`               | Custom render function for group rows.                    |
+| `onResetSort`                | `() => void`                                       | Callback to reset sorting.                                |
+| `onRowDoubleClick`           | `(item) => void`                                   | Callback when a row is double-clicked.                    |
+| `onSortByColumn`             | `(columnId) => void`                               | Callback when sorting by a column.                        |
+| `onAddListOption`            | `(newOption, header) => void`                      | Callback when adding a new list option.                   |
+| `onRowsReordered`            | `(fromIndex, toIndex) => void`                     | Callback when rows are reordered via drag & drop.         |
+
+---
+
+### `AdvancedTableSettings`
+
+| Property                | Type                             | Description                                 |
+| ----------------------- | -------------------------------- | ------------------------------------------- |
+| `marginTop`             | `string`                         | Top margin for the table.                   |
+| `noBorder`              | `boolean`                        | Removes the table border.                   |
+| `pinColumns`            | `boolean`                        | Pins columns for horizontal scrolling.      |
+| `alignCenterInLine`     | `boolean`                        | Centers content within rows.                |
+| `currentSortId`         | `string`                         | ID of the currently sorted column.          |
+| `contextMenu`           | `{ showOnHeader?, showOnCell? }` | Context menu visibility options.            |
+| `contrastRow`           | `boolean`                        | Alternates row background colors.           |
+| `indexUseOriginalOrder` | `boolean`                        | Uses original item order for index column.  |
+| `enableRowDragDrop`     | `boolean`                        | Enables row drag & drop reordering.         |
+| `currentUsername`       | `string`                         | Current user's username.                    |
+| `showIndex`             | `boolean`                        | Shows an index column.                      |
+| `selectNewOptionOnAdd`  | `boolean`                        | Auto-selects new option when added to list. |
+| `canAddListOptions`     | `boolean`                        | Allows adding new options to list columns.  |
+| `showFooter`            | `boolean`                        | Shows table footer.                         |
+| `rowIdProperty`         | `string`                         | Property to use as unique row identifier.   |
+| `tableId`               | `string`                         | Unique table identifier.                    |
+| `focusedRowIndex`       | `number`                         | Index of the focused row.                   |
+| `showFlashOnCellUpdate` | `boolean`                        | Shows flash animation on cell updates.      |
+| `disabledRows`          | `{ property, values }`           | Disables rows matching property values.     |
 
 ---
 
-## Header Definition
-
 ### `BaseTableHeader`
 
-| Property       | Type                                                              | Description                                     |
-| -------------- | ----------------------------------------------------------------- | ----------------------------------------------- |
-| `id`           | `string`                                                          | Unique identifier for the column.               |
-| `text`         | `string`                                                          | Display text for the column header.             |
-| `type`         | `'string', 'list', 'number'`                                      | Type of data in the column.                     |
-| `customHeader` | `(header: BaseTableHeader) => ReactNode`                          | Custom rendering function for the header.       |
-| `customRender` | `(item: TableItem, header: BaseTableHeader) => ReactNode`         | Custom rendering function for the cell content. |
-| `sortable`     | `boolean`                                                         | Enables sorting for the column.                 |
-| `customSort`   | `(a: TableItem, b: TableItem, ascendingOrder: boolean) => number` | Custom sorting function for the column.         |
-| `hasFilter`    | `boolean`                                                         | Enables filtering for the column.               |
-| `children`     | `BaseTableHeader[]`                                               | Nested columns for grouped headers.             |
-| `editOptions`  | `{ editable, required, type, defaultValue }`                      | Editing options for inline editing.             |
-
----
-
-## Data Items
-
-A `TableItem` is an object where each key matches a column ID defined in `headers`.
-
-```javascript
-const item = {
-  name: "John Doe",
-  age: "30",
-};
-```
-
----
-
-## Advanced Functionality
-
-### 1. **Row Highlighting**
-
-Highlight rows based on conditions:
-
-```jsx
-const highlightCondition = [
-  {
-    propertyId: "age",
-    value: "30",
-    style: { backgroundColor: "yellow" },
-  },
-];
-
-<BaseTable
-  headers={headers}
-  items={items}
-  highlightCondition={highlightCondition}
-/>;
-```
-
----
-
-### 2. **Custom Cell Rendering**
-
-Customize cell content using `customRender`:
-
-```jsx
-const headers = [
-  {
-    id: "name",
-    text: "Name",
-    customRender: (item) => <strong>{item.name}</strong>,
-  },
-];
-```
-
----
-
-### 3. **Sorting**
-
-Handle sorting logic with the `onSortByColumn` callback:
-
-```jsx
-const handleSort = (columnId) => {
-  console.log(`Sorting by column: ${columnId}`);
-};
-
-<BaseTable headers={headers} items={items} onSortByColumn={handleSort} />;
-```
-
----
-
-### 4. **Grouping Rows**
-
-Group rows by a column and allow collapsing:
-
-```jsx
-<BaseTable
-  headers={headers}
-  items={items}
-  groupBy="department" // group by the 'department' column
-/>
-```
-
----
-
-### 5. **Drag & Drop Rows**
-
-Enable drag-and-drop row reordering:
-
-```jsx
-<BaseTable headers={headers} items={items} enableRowDragDrop={true} />
-```
-
----
-
-### 6. **Context Menu**
-
-Show a custom context menu on right-click:
-
-```jsx
-<BaseTable
-  headers={headers}
-  items={items}
-  contextMenuActions={[
-    { label: "Edit", onClick: (item) => editItem(item) },
-    { label: "Delete", onClick: (item) => deleteItem(item) },
-  ]}
-/>
-```
-
----
-
-### 7. **Inline Editing**
-
-Allow editing cell values directly in the table by setting `editOptions` in headers.
-
-```jsx
-const headers = [
-  {
-    id: "age",
-    text: "Age",
-    editOptions: {
-      editable: true,
-      required: true,
-      type: "number",
-      defaultValue: 0,
-    },
-  },
-];
-```
-
----
-
-### 8. **Custom Header Rendering**
-
-Render custom header content:
-
-```jsx
-const headers = [
-  {
-    id: "actions",
-    text: "",
-    customHeader: () => <span>Actions</span>,
-  },
-];
-```
-
----
-
-## Styling & Theming
-
-- Uses Tailwind CSS and DaisyUI for styling.
-- You can override styles using Tailwind utility classes or DaisyUI themes.
-- Arbitrary values (e.g. `bg-[#f44333]`) are supported if included as static strings or added to the safelist in `tailwind.config.js`.
-
----
-
-## How to test the package in dev
-
-To create the package locally.
-
-```bash
-npm link
-```
-
-In your test project.
-
-```bash
-npm link react-base-data-table
-```
-
-#OLD
-
-Yalc emulates npm publish. It is preferred over npm link for fewer issues.
-
-```bash
-npm i yalc -g
-```
-
-In your package:
-
-```bash
-yalc publish
-```
-
-In the project that wants to consume the package:
-
-```bash
-yalc add @redevilkz/react-base-table
-```
-
-After a rebuild in your package:
-
-```bash
-yalc push
-```
-
-When you change something in your library:
-
-```bash
-npm run buildForNPM && yalc push --sig
-```
+| Property        | Type                                                       | Description                                  |
+| --------------- | ---------------------------------------------------------- | -------------------------------------------- |
+| `id`            | `string`                                                   | Unique column identifier (required).         |
+| `text`          | `string`                                                   | Column header display text (required).       |
+| `hasFilter`     | `boolean`                                                  | Enables filtering for the column.            |
+| `width`         | `number`                                                   | Column width in pixels.                      |
+| `children`      | `BaseTableHeader[]`                                        | Nested columns for grouped headers.          |
+| `editOptions`   | `EditOptions`                                              | Inline editing configuration.                |
+| `fromArray`     | `string`                                                   | Property name for array-based rows.          |
+| `arrayRowsOnly` | `boolean`                                                  | Shows cell only in array rows, not main row. |
+| `sortable`      | `boolean`                                                  | Enables sorting for the column.              |
+| `align`         | `'left' \| 'center' \| 'right'`                            | Cell content alignment.                      |
+| `customSort`    | `(a, b, ascending) => number`                              | Custom sorting function.                     |
+| `customHeader`  | `(header) => ReactNode`                                    | Custom header render function.               |
+| `customRender`  | `(item, header, fromArrayData?, isDisabled?) => ReactNode` | Custom cell render function.                 |
+
+---
+
+### `EditOptions`
+
+| Property                 | Type                                | Description                                |
+| ------------------------ | ----------------------------------- | ------------------------------------------ |
+| `editable`               | `boolean`                           | Enables inline editing.                    |
+| `isDisabled`             | `(item, fromArrayData?) => boolean` | Function to determine if cell is disabled. |
+| `notApplicable`          | `(item, fromArrayData?) => boolean` | Function to mark cell as N/A.              |
+| `greyedOutIfNotEditable` | `boolean`                           | Greys out non-editable cells.              |
+| `required`               | `boolean`                           | Marks field as required.                   |
+| `type`                   | `'string' \| 'list' \| 'number'`    | Cell data type.                            |
+| `options`                | `string[]`                          | Options for list type columns.             |
+| `defaultValue`           | `string \| number`                  | Default value for new items.               |
+| `canAddNewOption`        | `boolean`                           | Allows adding new options to list.         |
+
+---
+
+### `CollaborationConfig`
+
+| Property        | Type                  | Description                                           |
+| --------------- | --------------------- | ----------------------------------------------------- |
+| `collaborators` | `UserSelectionData[]` | List of collaborators and their selections.           |
+| `currentUserId` | `string`              | Current user's ID (to filter from display).           |
+| `debounceMs`    | `number`              | Debounce time for selection updates (default: 150ms). |
+| `color`         | `string`              | Current user's selection color.                       |
+| `version`       | `number`              | Collaboration data version.                           |
 
 ---