material-react-table 0.40.8 → 0.40.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# Material React Table
|
|
2
2
|
|
|
3
|
+
__Built with [Material UI <sup>V5</sup>](https://mui.com) and [TanStack Table <sup>V8</sup>](https://tanstack.com/table/v8)__
|
|
4
|
+
|
|
5
|
+
_Quickly Create React Data Tables with Material Design_
|
|
6
|
+
|
|
3
7
|
<a href="https://npmjs.com/package/material-react-table" target="_blank">
|
|
4
8
|
<img alt="" src="https://badgen.net/npm/v/material-react-table?color=blue" />
|
|
5
9
|
</a>
|
|
@@ -19,8 +23,6 @@
|
|
|
19
23
|
<img alt="" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" />
|
|
20
24
|
</a>
|
|
21
25
|
|
|
22
|
-
---
|
|
23
|
-
|
|
24
26
|
## About
|
|
25
27
|
|
|
26
28
|
> This project is still in alpha, but is expected to enter beta by August 2022, and a stable 1.0 release shortly thereafter.
|
|
@@ -36,12 +38,10 @@ View the [Docs Website](https://www.material-react-table.com/)
|
|
|
36
38
|
|
|
37
39
|
See all [Props and Options](https://www.material-react-table.com/docs/api)
|
|
38
40
|
|
|
39
|
-
---
|
|
40
|
-
|
|
41
41
|
## Quick Examples
|
|
42
42
|
|
|
43
43
|
- [Basic Table](https://www.material-react-table.com/docs/examples/basic/) (See Default Features)
|
|
44
|
-
- [Minimal Table](https://www.material-react-table.com/docs/examples/minimal/) (Turn off Features)
|
|
44
|
+
- [Minimal Table](https://www.material-react-table.com/docs/examples/minimal/) (Turn off Features like Pagination, Sorting, Filtering, and Toolbars)
|
|
45
45
|
- [Advanced Table](https://www.material-react-table.com/docs/examples/advanced/) (See some of the Advanced Features)
|
|
46
46
|
- [Aggregation/Grouping](https://www.material-react-table.com/docs/examples/aggregation-and-grouping/) (Aggregation features such as Sum, Average, Count, etc.)
|
|
47
47
|
- [Data Export Table](https://www.material-react-table.com/docs/examples/data-export/) (Export to CSV, Excel, etc.)
|
|
@@ -53,8 +53,6 @@ See all [Props and Options](https://www.material-react-table.com/docs/api)
|
|
|
53
53
|
|
|
54
54
|
View additional [storybook examples](https://www.material-react-table.dev/)
|
|
55
55
|
|
|
56
|
-
---
|
|
57
|
-
|
|
58
56
|
## Features (All Features work and are MVP, but are still being polished)
|
|
59
57
|
|
|
60
58
|
_All features can easily be enabled/disabled_
|
|
@@ -91,8 +89,6 @@ _All features can easily be enabled/disabled_
|
|
|
91
89
|
- [x] Tree Data / Expanding Sub-rows
|
|
92
90
|
- [x] Virtualization (react-virtual)
|
|
93
91
|
|
|
94
|
-
---
|
|
95
|
-
|
|
96
92
|
## Getting Started
|
|
97
93
|
|
|
98
94
|
### Installation
|
|
@@ -113,13 +109,11 @@ npm install material-react-table
|
|
|
113
109
|
|
|
114
110
|
> _`@tanstack/react-table`, `@tanstack/react-virtual`, and `@tanstack/match-sorter-utils`_ are internal dependencies, so you don't need to install them yourself.
|
|
115
111
|
|
|
116
|
-
---
|
|
117
|
-
|
|
118
112
|
### Usage
|
|
119
113
|
|
|
120
114
|
> Read the full usage docs [here](https://www.material-react-table.com/docs/getting-started/usage/)
|
|
121
115
|
|
|
122
|
-
```
|
|
116
|
+
```jsx
|
|
123
117
|
import React, { useMemo, useState, useEffect } from 'react';
|
|
124
118
|
import MaterialReactTable from 'material-react-table';
|
|
125
119
|
|
|
@@ -178,8 +172,6 @@ export default function App() {
|
|
|
178
172
|
|
|
179
173
|
_Open in [Code Sandbox](https://codesandbox.io/s/simple-material-react-table-example-t5c3ji)_
|
|
180
174
|
|
|
181
|
-
---
|
|
182
|
-
|
|
183
175
|
## Contributors
|
|
184
176
|
|
|
185
177
|
<a href="https://github.com/kevinvandy/material-react-table/graphs/contributors">
|
|
@@ -160,7 +160,7 @@ export declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit
|
|
|
160
160
|
filterFn?: MRT_FilterFn<TData>;
|
|
161
161
|
filterSelectOptions?: (string | {
|
|
162
162
|
text: string;
|
|
163
|
-
value:
|
|
163
|
+
value: any;
|
|
164
164
|
})[];
|
|
165
165
|
filterVariant?: 'text' | 'select' | 'multi-select' | 'range';
|
|
166
166
|
/**
|
|
@@ -160,7 +160,7 @@ export declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit
|
|
|
160
160
|
filterFn?: MRT_FilterFn<TData>;
|
|
161
161
|
filterSelectOptions?: (string | {
|
|
162
162
|
text: string;
|
|
163
|
-
value:
|
|
163
|
+
value: any;
|
|
164
164
|
})[];
|
|
165
165
|
filterVariant?: 'text' | 'select' | 'multi-select' | 'range';
|
|
166
166
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -352,7 +352,7 @@ declare type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<Column
|
|
|
352
352
|
filterFn?: MRT_FilterFn<TData>;
|
|
353
353
|
filterSelectOptions?: (string | {
|
|
354
354
|
text: string;
|
|
355
|
-
value:
|
|
355
|
+
value: any;
|
|
356
356
|
})[];
|
|
357
357
|
filterVariant?: 'text' | 'select' | 'multi-select' | 'range';
|
|
358
358
|
/**
|
package/package.json
CHANGED
|
@@ -264,7 +264,7 @@ export type MRT_ColumnDef<TData extends Record<string, any> = {}> = Omit<
|
|
|
264
264
|
enableColumnOrdering?: boolean;
|
|
265
265
|
enableEditing?: boolean;
|
|
266
266
|
filterFn?: MRT_FilterFn<TData>;
|
|
267
|
-
filterSelectOptions?: (string | { text: string; value:
|
|
267
|
+
filterSelectOptions?: (string | { text: string; value: any })[];
|
|
268
268
|
filterVariant?: 'text' | 'select' | 'multi-select' | 'range';
|
|
269
269
|
/**
|
|
270
270
|
* footer must be a string. If you want custom JSX to render the footer, you can also specify a `Footer` option. (Capital F)
|