mui-datatables-updated 1.0.1 → 1.0.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Diego Jacobo Martínez
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Diego Jacobo Martínez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,175 +1,185 @@
-# MUI Datatable library inspired by the gregnb/mui-datatables project, featuring an up-to-date implementation with Typescript Support
-
-## Installation
-
-```bash
-npm install mui-datatables-updated
-```
-
-## Usage
-
-```jsx
-import React from 'react';
-import MUIDataTable from 'mui-datatables-updated';
-
-const sampleData = [
-  {
-    "id": 1,
-    "name": "Cupcake",
-    "carbs": 67,
-  },
-  {
-    "id": 2,
-    "name": "Donut",
-    "carbs": 51,
-  }
-];
-
-export default function App() {
-  return (
-    <>
-      <MUITable title='Sample title' data={sampleData} />
-    </>
-  )
-}
-```
-
-## Options
-
-| Name | Type | Description |
-| --- | --- | --- |
-| title | string | Title of the table |
-| data | array | Data to be displayed in the table |
-| deactivateSelect | boolean | Disable row selection |
-| defaultOrderBy | string -> must be a key in the data object | Default order by key to sort the table data on first load |
-| defaultOrder | 'asc' or 'desc' | Default order to be used when sorting and displaying on first load |
-| excludedColumns | array | Array of **keys** in data objects to be excluded from the table |
-| columns | array | Array of objects to define the columns of the table |
-| options | object | Object to define the options of the table |
-
-### Example
-
-```jsx
-import MUITable from 'mui-datatables-updated'
-
-const sampleColumns = [
-  {
-    name: 'name',
-    label: 'Name of dessert',
-  },
-  {
-    name: 'healthy',
-    label: 'Is Healthy?',
-    options: {
-      sort: false,
-      customBodyRender: (value: boolean) => value ? ':)' : ':('
-    }
-  },
-  {
-    name: 'carbs',
-    label: 'Carbs (g)',
-    options: {
-      sort: false
-    }
-  },
-  {
-    name: 'id',
-    label: 'ID',
-  }
-]
-
-function App() {
-  return (
-    <>
-      <h1>MUI Table test</h1>
-      <MUITable
-        title='Sample Test'
-        data={sampleData}
-        defaultOrder='desc'
-        defaultOrderBy='name'
-        excludedColumns={['id']}
-      />
-      <MUITable
-        title='Sample Test'
-        data={sampleData}
-        defaultOrder='desc'
-        defaultOrderBy='name'
-        columns={sampleColumns}
-        deactivateSelect
-        options={{
-          translations: {
-            filterTooltip: 'Filtrar',
-            filtersTitle: 'Filtros',
-            resetButtonText: 'Reiniciar',
-            searchPlaceholder: 'Buscar...',
-            rowsPerPageText: 'Filas por página',
-            selectedTextRenderer: (numSelected) => `${numSelected} seleccionado/s`,
-            labelDisplayedRows: ({ from, to, count }) => `${from}-${to} de ${count}`,
-          }
-        }}
-      />
-    </>
-  )
-}
-```
-
-## Custom Columns
-
-On each column object, you have the ability to customize columns to show the filtering options in the filter dropdown and to disable sorting when clicking on the column header. Values are set to true by default.
-
-| Name | Type | Description |
-| --- | --- | --- |
-| name | string | Key in the data object |
-| label | string | Label to be displayed in the column header |
-| options | object | Object to define the options of the column |
-
-### Options Object
-
-| Name | Type | Description |
-| --- | --- | --- |
-| customBodyRender | function | Function to render custom content in the column |
-| filter | boolean | Show filter dropdown in the column |
-| sort | boolean | Enable sorting when clicking on the column header |
-
-### Custom columns example
-
-```jsx
-const columns = [
- {
-  name: "active",
-  label: "Is Active",
-  options: {
-    customBodyRender: (value: boolean) => value ? 'Yes' : 'No',
-    filter: true,
-    sort: false
-  }
- },
- ...
-];
-```
-
-## Localization
-
-As well as gregnb original package, I decided that the cost of bringing in another library to perform localizations would be too expensive. Instead the ability to override most text labels (which aren't many) is offered through the translations property. The available customizations are:
-
-```jsx
-<MUITable
-  title='Sample Test'
-  data={sampleData}
-  options={{
-    translations: {
-      filterTooltip: 'Filtrar',
-      filtersTitle: 'Filtros',
-      resetButtonText: 'Reiniciar',
-      searchPlaceholder: 'Buscar...',
-      rowsPerPageText: 'Filas por página',
-      selectedTextRenderer: (numSelected) => `${numSelected} seleccionado/s`,
-      labelDisplayedRows: ({ from, to, count }) => `${from}-${to} de ${count}`,
-    }
-  }}
-/>
-```
-
-## Contributing
-
-Pull requests are welcome. I won't be able to implement new features in the short term, so feel free to contribute to the project by adding new features, fixing bugs, creating tests, and improving the documentation.
+# MUI Datatable library inspired by the gregnb/mui-datatables project, featuring an up-to-date implementation with Typescript Support
+
+## Installation
+
+If not already installed, install the Material-UI library:
+
+```bash
+npm install @mui/material @emotion/react @emotion/styled @mui/icons-material @mui/utils
+```
+
+Then install the mui-datatables-updated package along with its peer dependencies:
+
+```bash
+npm install mui-datatables-updated react-to-print
+```
+
+## Usage
+
+```jsx
+import React from 'react';
+import { MUITable } from 'mui-datatables-updated';
+
+const sampleData = [
+  {
+    "id": 1,
+    "name": "Cupcake",
+    "carbs": 67,
+  },
+  {
+    "id": 2,
+    "name": "Donut",
+    "carbs": 51,
+  }
+];
+
+export default function App() {
+  return (
+    <>
+      <MUITable title='Sample title' data={sampleData} />
+    </>
+  )
+}
+```
+
+## Options
+
+| Name | Type | Description |
+| --- | --- | --- |
+| title | string | Title of the table |
+| data | array | Data to be displayed in the table |
+| deactivateSelect | boolean | Disable row selection |
+| defaultOrderBy | string -> must be a key in the data object | Default order by key to sort the table data on first load |
+| defaultOrder | 'asc' or 'desc' | Default order to be used when sorting and displaying on first load |
+| excludedColumns | array | Array of **keys** in data objects to be excluded from the table |
+| columns | array | Array of objects to define the columns of the table |
+| options | object | Object to define the options of the table |
+
+### Example
+
+```jsx
+import { MUITable } from 'mui-datatables-updated';
+
+const sampleColumns = [
+  {
+    name: 'name',
+    label: 'Name of dessert',
+  },
+  {
+    name: 'healthy',
+    label: 'Is Healthy?',
+    options: {
+      sort: false,
+      customBodyRender: (value: boolean) => value ? ':)' : ':('
+    }
+  },
+  {
+    name: 'carbs',
+    label: 'Carbs (g)',
+    options: {
+      sort: false
+    }
+  },
+  {
+    name: 'id',
+    label: 'ID',
+  }
+]
+
+function App() {
+  return (
+    <>
+      <h1>MUI Table test</h1>
+      <MUITable
+        title='Sample Test'
+        data={sampleData}
+        defaultOrder='desc'
+        defaultOrderBy='name'
+        excludedColumns={['id']}
+      />
+      <MUITable
+        title='Sample Test'
+        data={sampleData}
+        defaultOrder='desc'
+        defaultOrderBy='name'
+        columns={sampleColumns}
+        deactivateSelect
+        options={{
+          translations: {
+            filterTooltip: 'Filtrar',
+            filtersTitle: 'Filtros',
+            resetButtonText: 'Reiniciar',
+            searchPlaceholder: 'Buscar...',
+            rowsPerPageText: 'Filas por página',
+            selectedTextRenderer: (numSelected) => `${numSelected} seleccionado/s`,
+            labelDisplayedRows: ({ from, to, count }) => `${from}-${to} de ${count}`,
+          }
+        }}
+      />
+    </>
+  )
+}
+```
+
+## Custom Columns
+
+On each column object, you have the ability to customize columns to show the filtering options in the filter dropdown and to disable sorting when clicking on the column header. Values are set to true by default.
+
+| Name | Type | Description |
+| --- | --- | --- |
+| name | string | Key in the data object |
+| label | string | Label to be displayed in the column header |
+| options | object | Object to define the options of the column |
+
+### Options Object
+
+| Name | Type | Description |
+| --- | --- | --- |
+| customBodyRender | function | Function to render custom content in the column |
+| customSearchValue | function | Function to provide searchable text/value for global search (useful with customBodyRender) |
+| filter | boolean | Show filter dropdown in the column |
+| sort | boolean | Enable sorting when clicking on the column header |
+
+### Custom columns example
+
+```jsx
+const columns = [
+ {
+  name: "active",
+  label: "Is Active",
+  options: {
+    customBodyRender: (value: boolean) => value ? 'Yes' : 'No',
+    customSearchValue: (value: boolean) => value ? 'Yes' : 'No',
+    filter: true,
+    sort: false
+  }
+ },
+ ...
+];
+```
+
+## Localization
+
+As well as gregnb original package, I decided that the cost of bringing in another library to perform localizations would be too expensive. Instead the ability to override most text labels (which aren't many) is offered through the translations property. The available customizations are:
+
+```jsx
+<MUITable
+  title='Sample Test'
+  data={sampleData}
+  options={{
+    translations: {
+      filterTooltip: 'Filtrar',
+      filtersTitle: 'Filtros',
+      resetButtonText: 'Reiniciar',
+      searchPlaceholder: 'Buscar...',
+      rowsPerPageText: 'Filas por página',
+      selectedTextRenderer: (numSelected) => `${numSelected} seleccionado/s`,
+      labelDisplayedRows: ({ from, to, count }) => `${from}-${to} de ${count}`,
+    }
+  }}
+/>
+```
+
+## Contributing
+
+Pull requests are welcome. I won't be able to implement new features in the short term, so feel free to contribute to the project by adding new features, fixing bugs, creating tests, and improving the documentation.

package/dist/components/MUITable.d.ts

@@ -1,12 +1,13 @@
 import React from 'react';
-import { CustomSelectedToolbarProps } from './Toolbar';
-import { Order } from './utils';
-import { LabelDisplayedRowsArgs } from '@mui/material/TablePagination';
+import { type CustomSelectedToolbarProps } from './Toolbar';
+import { type Order } from './utils';
+import type { LabelDisplayedRowsArgs } from '@mui/material/TablePagination';
 export interface Column {
     name: string;
     label?: string;
     options?: {
         customBodyRender?: (value: any) => React.ReactNode;
+        customSearchValue?: (value: any, row: Record<string, any>) => unknown;
         filter?: boolean;
         sort?: boolean;
     };

package/dist/components/TableHead.d.ts

@@ -1,5 +1,5 @@
-import { Column } from './MUITable';
-import { Order } from './utils';
+import type { Column } from './MUITable';
+import type { Order } from './utils';
 interface EnhancedTableProps<T> {
     numSelected: number;
     onRequestSort: (event: React.MouseEvent<unknown>, property: keyof T) => void;

package/dist/components/Toolbar.d.ts

@@ -1,6 +1,6 @@
 import React from "react";
-import { Column, Options } from "./MUITable";
-import { UseReactToPrintFn } from "react-to-print";
+import type { Column, Options } from "./MUITable";
+import type { UseReactToPrintFn } from "react-to-print";
 export interface CustomSelectedToolbarProps<T> {
     selected?: readonly T[];
     data?: T[];
@@ -18,5 +18,5 @@ interface EnhancedTableToolbarProps<T> {
     data?: T[];
     options?: Options;
 }
-export declare function EnhancedTableToolbar<T>(props: EnhancedTableToolbarProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function EnhancedTableToolbar<T extends object>(props: EnhancedTableToolbarProps<T>): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/utils.d.ts

@@ -1,2 +1,13 @@
 export type Order = 'asc' | 'desc';
+export interface SearchColumn<T extends object> {
+    name: string;
+    options?: {
+        customBodyRender?: (value: any) => unknown;
+        customSearchValue?: (value: any, row: Record<string, any>) => unknown;
+    };
+}
 export declare function getComparator<T, Key extends keyof T>(order: Order, orderBy: Key): (a: T, b: T) => number;
+export declare function toSearchTokens(value: unknown): string[];
+export declare function getColumnSearchTokens<T extends object>(row: T, column: SearchColumn<T>): string[];
+export declare function columnMatchesSearchQuery<T extends object>(row: T, column: SearchColumn<T>, searchQuery: string): boolean;
+export declare function rowMatchesSearchQuery<T extends object>(row: T, columns: SearchColumn<T>[], searchQuery: string): boolean;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { MUITable as default } from './components/MUITable';
+export { MUITable } from './components/MUITable';
 export type { Column } from './components/MUITable';
 export type { CustomSelectedToolbarProps } from './components/Toolbar';