npm - material-react-table-narender - Versions diffs - 1.0.0 - Mend

material-react-table-narender 1.0.0

Files changed (1769) hide show

package/apps/material-react-table-docs/pages/docs/guides/click-to-copy.mdx ADDED Viewed

@@ -0,0 +1,78 @@
+import Head from 'next/head';
+import TableOptionsTable from '../../../components/prop-tables/TableOptionsTable';
+import ColumnOptionsTable from '../../../components/prop-tables/ColumnOptionsTable';
+import Example from '../../../examples/enable-click-to-copy';
+<Head>
+  <title>Click to Copy Guide - Material React Table V3 Docs</title>
+  <meta
+    name="description"
+    content="How to use and customize the click to copy features of Material React Table"
+  />
+</Head>
+## Click to Copy Feature Guide
+Material React Table has an easy-to-implement feature that allows a user to copy a cell's value to the clipboard.
+### Relevant Table Options
+<TableOptionsTable
+  onlyOptions={new Set(['enableClickToCopy', 'muiCopyButtonProps'])}
+/>
+### Relevant Column Options
+<ColumnOptionsTable
+  onlyOptions={new Set(['enableClickToCopy', 'muiCopyButtonProps'])}
+/>
+### Enable Click to Copy Per Column
+Most likely, there will just be a couple columns that you want to enable click to copy for. You can do this by setting the `enableClickToCopy` option to `true` per column on the column definition.
+```tsx
+const columns = [
+  //...
+  {
+    accessorKey: 'email',
+    header: 'Email',
+    enableClickToCopy: true,
+  },
+  //...
+];
+```
+### Enable Click to Copy For All Cells
+Alternatively, you can enable click to copy globally by setting the `enableClickToCopy` table option to `true`. You could then opt out per column by setting the `enableClickToCopy` option to `false` on the column definition.
+```tsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  enableClickToCopy: true,
+});
+```
+### Customize Copy Buttons
+The click to copy feature is built on top of the Material UnstyledButton and CopyButton components. You can customize the copy button by passing in the `muiCopyButtonProps` table or column option.
+```tsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  enableClickToCopy: true,
+  muiCopyButtonProps: {
+    sx: { width: '100%' },
+    startIcon: <ContentCopy />,
+  },
+});
+```
+### Click to Copy Example
+<Example />
+View Extra Storybook **[Examples](https://www.material-react-table.dev/?path=/story/features-click-to-copy-examples)**

package/apps/material-react-table-docs/pages/docs/guides/column-actions.mdx ADDED Viewed

@@ -0,0 +1,92 @@
+import Head from 'next/head';
+import TableOptionsTable from '../../../components/prop-tables/TableOptionsTable';
+import ColumnOptionsTable from '../../../components/prop-tables/ColumnOptionsTable';
+import DisableExample from '../../../examples/disable-column-actions';
+import CustomColumnActionsExample from '../../../examples/custom-column-actions';
+import ColumnActionsSpaceExample from '../../../examples/column-actions-space';
+<Head>
+  <title>{'Column Actions Guide - Material React Table V3 Docs'}</title>
+  <meta
+    name="description"
+    content="How to use, customize, or disable column the action button and menu features of Material React Table"
+  />
+</Head>
+## Column Actions Feature Guide
+By default, Material React Table renders a column actions button for each column header. It contains a drop-down menu to help your users use the other features of the table. All of these actions can be triggered in some other way other than from this drop-down menu, so this serves as a UI/UX alternative to make sure your users can find many of the table features easily.
+### Relevant Table Options
+<TableOptionsTable
+  onlyOptions={
+    new Set([
+      'enableColumnActions',
+      'muiColumnActionsButtonProps',
+      'renderColumnActionsMenuItems',
+    ])
+  }
+/>
+### Relevant Column Options
+<ColumnOptionsTable
+  onlyOptions={
+    new Set([
+      'enableColumnActions',
+      'muiColumnActionsButtonProps',
+      'renderColumnActionsMenuItems',
+    ])
+  }
+/>
+### Disable or Hide Column Actions Buttons
+You can set the `enableColumnActions` table option to `false` in the table to disable this feature and hide the button in each column header completely.
+```jsx
+const table = useMaterialReactTable({
+  data,
+  columns,
+  enableColumnActions: false,
+});
+return <MaterialReactTable table={table} />;
+```
+Alternatively, if you only want to hide the column actions button in specific columns, you can set the `enableColumnActions` option for the desired column definition to `false` instead.
+In this demo, we disable the column actions button for the 'ID' column.
+<DisableExample />
+### Custom Column Actions Menu
+If you do not like the default column actions menu items that Material React Table generates, you can provide your own custom menu items with the `renderColumnActionsMenuItems` table or column option. You can choose whether or not to include the internal menu items by using the `internalColumnMenuItems` parameter.
+```jsx
+const table = useMaterialReactTable({
+  data,
+  columns,
+  renderColumnActionsMenuItems: ({ internalColumnMenuItems }) => {
+    return [
+      ...internalColumnMenuItems, //optionally include the internal menu items above or below your custom menu items
+      <MenuItem key="custom-menu-item-1">Custom Menu Item 1</MenuItem>,
+      <MenuItem key="custom-menu-item-2">Custom Menu Item 2</MenuItem>,
+    ];
+  },
+});
+return <MaterialReactTable table={table} />;
+```
+<CustomColumnActionsExample />
+### Justify Column Actions Button
+By default, the column actions button is left aligned directly after the column header text and any sort or filter labels that may be present. If you want to change this, you can use a CSS selector in `muiTableHeadCellProps` to change the `justify-content` property of the column header container.
+<ColumnActionsSpaceExample />
+View Extra Storybook **[Examples](https://www.material-react-table.dev/?path=/story/features-column-action-examples)**

package/apps/material-react-table-docs/pages/docs/guides/column-filtering.mdx ADDED Viewed

@@ -0,0 +1,397 @@
+import Head from 'next/head';
+import Box from '@mui/material/Box';
+import TableOptionsTable from '../../../components/prop-tables/TableOptionsTable';
+import ColumnOptionsTable from '../../../components/prop-tables/ColumnOptionsTable';
+import StateOptionsTable from '../../../components/prop-tables/StateOptionsTable';
+import AlternateExample from '../../../examples/alternate-column-filtering';
+import CustomizeFilterVariantsExample from '../../../examples/customize-filter-variants';
+import CustomizeFilterModesExample from '../../../examples/customize-filter-modes';
+import CustomizeFilterComponentsExample from '../../../examples/customize-filter-components';
+import EnableColumnFacetValuesExample from '../../../examples/enable-filter-facet-values';
+<Head>
+  <title>{'Column Filtering Guide - Material React Table V3 Docs'}</title>
+  <meta
+    name="description"
+    content="How to use, customize, or disable filter features, client-side or server side, in Material React Table"
+  />
+</Head>
+## Column Filtering Feature Guide
+Filtering is one of the most powerful features of Material React Table and is enabled by default. There is a lot of flexibility and customization available here. Whether you want to customize the powerful client-side filtering already built in or implement your own [server-side filtering](#manual-server-side-column-filtering), Material React Table has got you covered.
+### Relevant Table Options
+<TableOptionsTable
+  onlyOptions={
+    new Set([
+      'columnFilterModeOptions',
+      'enableColumnFilterModes',
+      'enableColumnFilters',
+      'enableFacetedValues',
+      'enableFilterMatchHighlighting',
+      'enableFilters',
+      'filterFns',
+      'filterFromLeafRows',
+      'getFacetedMinMaxValues',
+      'getFacetedRowModel',
+      'getFacetedUniqueValues',
+      'getFilteredRowModel',
+      'manualFiltering',
+      'maxLeafRowFilterDepth',
+      'muiFilterAutocompleteProps',
+      'muiFilterCheckboxProps',
+      'muiFilterDatePickerProps',
+      'muiFilterDateTimePickerProps',
+      'muiFilterSliderProps',
+      'muiFilterTextFieldProps',
+      'muiFilterTimePickerProps',
+      'onColumnFilterFnsChange',
+      'onColumnFiltersChange',
+      'onShowColumnFiltersChange',
+      'renderColumnFilterModeMenuItems',
+    ])
+  }
+/>
+### Relevant Column Options
+<ColumnOptionsTable
+  onlyOptions={
+    new Set([
+      'Filter',
+      'columnFilterModeOptions',
+      'enableColumnFilter',
+      'enableColumnFilterModes',
+      'enableFilterMatchHighlighting',
+      'filterFn',
+      'filterSelectOptions',
+      'filterVariant',
+      'muiFilterAutocompleteProps',
+      'muiFilterCheckboxProps',
+      'muiFilterDatePickerProps',
+      'muiFilterDateTimePickerProps',
+      'muiFilterSliderProps',
+      'muiFilterTextFieldProps',
+      'muiFilterTimePickerProps',
+      'renderColumnFilterModeMenuItems',
+    ])
+  }
+/>
+### Relevant State Options
+<StateOptionsTable
+  onlyOptions={
+    new Set(['columnFilters', 'columnFilterFns', 'showColumnFilters'])
+  }
+/>
+### Disable Filtering Features
+Various subsets of filtering features can be disabled. If you want to disable filtering completely, you can set the `enableColumnFilters` table option to `false` to remove all filters from each column. Alternatively, `enableColumnFilter` can be set to `false` for individual columns.
+`enableFilters` can be set to `false` to disable both column filters and the global search filter.
+### Filter Variants
+Material React Table has several built-in filter variants for advanced filtering. These can be specified on a per-column basis using the `filterVariant` option. The following variants are available:
+- `'text'` - shows the default text field
+- `'autocomplete'` - shows an autocomplete text field with the options from faceted values or specified in `filterSelectOptions` array.
+- `'select'` - shows a select dropdown with the options from faceted values or specified in `filterSelectOptions` array.
+- `'multi-select'` - shows a select dropdown with the options from faceted values or specified in `filterSelectOptions` and allows multiple selections with checkboxes
+- `'range'` - shows min and max text fields for filtering a range of values
+- `'range-slider'` - shows a slider for filtering a range of values
+- `'date'` - shows a date picker for filtering by date values
+- `'datetime'` - shows a date and time picker for filtering by date and time values
+- `'date-range'` - shows a date range picker for filtering by date ranges
+- `'datetime-range'` - shows a date and time range picker for filtering by date and time ranges
+- `'time'` - shows a time picker for filtering by time values
+- `'time-range'` - shows a time range picker for filtering by time ranges
+- `'checkbox'` - shows a checkbox for filtering by `'true'` or `'false'` values
+> `'autocomplete'`, `'date'`, and `'date-range'`, variants are new in v2.0.0
+>
+> `datetime`, `datetime-range`, `time`, and `time-range` variants are new in v2.4.0
+<CustomizeFilterVariantsExample />
+#### Faceted Values for Filter Variants
+Faceted values are a list of unique values for a column that gets generated under the hood from table data when the `enableFacetedValues` table option is set to `true`. These values can be used to populate the select dropdowns for the `'select'` and `'multi-select'` filter variants, or the min and max values for the `'range-slider'` variant. This means that you no longer need to manually specify the `filterSelectOptions` table option for these variants manually, especially if you are using client-side filtering.
+<EnableColumnFacetValuesExample />
+#### Custom Faceted Values
+If you are using server-side pagination and filtering, you can still customize the faceted values output with the `getFacetedUniqueValues` and `getFacetedMinMaxValues` props.
+```jsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  enableFacetedValues: true,
+  //if using server-side pagination and filtering
+  getFacetedMinMaxValues: (table) => {
+    //fetch min and max values from server
+    return [minValue, maxValue];
+  },
+  //if using server-side filtering
+  getFacetedUniqueValues: (table) => {
+    const uniqueValueMap = new Map<string, number>();
+    //fetch unique values from server, ideally including the count of each unique value
+    return uniqueValueMap;
+  },
+})
+```
+### Column Filter Display Modes
+By default, column filters inputs show below the column header. You can switch to a more "excel-like" UI by setting the `columnFilterDisplayMode` table option to `'popover'`. This will show a filter icon in the column header that can be clicked to open a popover with the filter input.
+```jsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  columnFilterDisplayMode: 'popover', //filter inputs will show in a popover (like excel)
+});
+```
+Alternatively, if you want to render your own column filter UI in a separate sidebar, but still want to use the built-in filtering functionality, you can set the `columnFilterDisplayMode` table option to `'custom'`.
+```jsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  columnFilterDisplayMode: 'custom', //render your own column filter UI (e.g. in a sidebar)
+});
+```
+<AlternateExample />
+### Custom Filter Functions
+You can specify either a pre-built filterFn that comes with Material React Table or pass in your own custom filter functions.
+#### Custom Filter Functions Per Column
+By default, Material React Table uses a `fuzzy` filtering algorithm based on the popular `match-sorter` [library from Kent C. Dodds](https://www.npmjs.com/package/match-sorter). However, Material React Table also comes with numerous other filter functions that you can specify per column in the `filterFn` column options.
+##### Pre-built MRT Filter Functions
+> Pre-built filter functions from Material React Table include `between`, `betweenInclusive`, `contains`, `empty`, `endsWith`, `equals`, `fuzzy`, `greaterThan`, `greaterThanOrEqualTo`, `lessThan`, `lessThanOrEqualTo`, `notEmpty`, `notEquals`, and `startsWith`. View these algorithms [here](https://github.com/KevinVandy/material-react-table/blob/v3/packages/material-react-table/src/fns/filterFns.ts)
+##### Pre-built TanStack Table Filter Functions
+> Pre-built filter functions from TanStack Table include `includesString`, `includesStringSensitive`, `equalsString`, `equalsStringSensitive`, `arrIncludes`, `arrIncludesAll`, `arrIncludesSome`, `weakEquals`, and `inNumberRange`. View more information about these algorithms in the [TanStack Table Filter docs](https://tanstack.com/table/v8/docs/api/features/filters#filter-functions).
+You can specify either a pre-built filter function, from Material React Table or TanStack Table, or you can even specify _your own custom filter function_ in the `filterFn` column option.
+```jsx
+const columns = [
+  {
+    accessorKey: 'firstName',
+    header: 'First Name',
+    // using a prebuilt filter function from Material React Table
+    filterFn: 'startsWith',
+  },
+  {
+    accessorKey: 'middleName',
+    header: 'Middle Name',
+    // using a prebuilt filter function from TanStack Table
+    filterFn: 'includesStringSensitive',
+  },
+  {
+    accessorKey: 'lastName',
+    header: 'Last Name',
+    // custom filter function
+    filterFn: (row, id, filterValue) =>
+      row.getValue(id).startsWith(filterValue),
+  },
+];
+```
+If you provide a custom filter function, it must have the following signature:
+```ts
+(row: Row<TData>, id: string, filterValue: string | number) => boolean;
+```
+This function will be used to filter 1 row at a time and should return a `boolean` indicating whether or not that row passes the filter.
+#### Add Custom Filter Functions
+You can add custom filter functions to the `filterFns` table option. These will be available to all columns to use. The `filterFn` table option on a column will override any filter function with the same name in the `filterFns` table option.
+```jsx
+const columns = [
+  {
+    accessorKey: 'name',
+    header: 'Name',
+    filterFn: 'customFilterFn',
+  },
+];
+const table = useMaterialReactTable({
+  columns,
+  data,
+  filterFns: {
+    customFilterFn: (row, id, filterValue) => {
+      return row.customField === value;
+    },
+  },
+});
+```
+### Filter Modes
+#### Enable Column Filter Modes (Filter Switching)
+If you want to let the user switch between multiple different filter modes from a drop-down menu on the Filter Textfield, you can enable that with the `enableColumnFilterModes` table option or column option. This will enable the filter icon in the filter text field to open a drop-down menu with the available filter modes when clicked.
+```tsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  enableColumnFilterModes: true,
+});
+```
+#### Customize Filter Modes
+You can narrow down the available filter mode options by setting the `columnFilterModeOptions` table option or a column specific `columnFilterModeOptions` option.
+```tsx
+const columns = [
+  {
+    accessorKey: 'firstName',
+    header: 'First Name',
+    columnFilterModeOptions: ['fuzzy', 'contains', 'startsWith'],
+  },
+  {
+    accessorKey: 'age',
+    header: 'Age',
+    columnFilterModeOptions: ['between', 'lessThan', 'greaterThan'],
+  },
+];
+```
+#### Render Custom Filter Mode Menu
+You can also render custom menu items in the filter mode drop-down menu by setting the `renderColumnFilterModeMenuItems` table option or column option. This option is a function that takes in the column and returns an array of `MenuItem` components. This is useful if you want to add custom filter modes that are not included in Material React Table, or if you just want to render the menu in your own custom way
+```jsx
+const columns = [
+  {
+    accessorKey: 'firstName',
+    header: 'First Name',
+    renderColumnFilterModeMenuItems: ({ column, onSelectFilterMode }) => [
+      <MenuItem
+        key="startsWith"
+        onClick={() => onSelectFilterMode('startsWith')}
+      >
+        Start With
+      </MenuItem>,
+      <MenuItem
+        key="endsWith"
+        onClick={() => onSelectFilterMode('yourCustomFilterFn')}
+      >
+        Your Custom Filter Fn
+      </MenuItem>,
+    ],
+  },
+];
+const table = useMaterialReactTable({
+  columns,
+  data,
+  enableColumnFilterModes: true,
+  // renderColumnFilterModeMenuItems could go here if you want to apply to all columns
+});
+return <MaterialReactTable table={table} />;
+```
+<CustomizeFilterModesExample />
+### Expanded Leaf Row Filtering Options
+If you are using the filtering features along-side either the [grouping](/docs/guides/aggregation-and-grouping) or [expanding](/docs/guides/expanding-sub-rows) features, then there are a few behaviors and customizations you should be aware of.
+Check out the [Expanded Leaf Row Filtering Behavior docs](/docs/guides/expanding-sub-rows#expanded-leaf-row-filtering-behavior) to learn more about the `filterFromLeafRows` and `maxLeafRowFilterDepth` props.
+### Manual Server-Side Column Filtering
+A very common use case when you have a lot of data is to filter the data on the server, instead of client-side. In this case, you will want to set the `manualFiltering` table option to `true` and manage the `columnFilters` state yourself like so (can work in conjunction with [manual global filtering](https://www.material-react-table.com/docs/guides/global-filtering#manual-server-side-global-filtering)).
+```jsx
+// You can manage and have control over the columnFilters state yourself
+const [columnFilters, setColumnFilters] = useState([]);
+const [data, setData] = useState([]); //data will get updated after re-fetching
+useEffect(() => {
+  const fetchData = async () => {
+    // send api requests when columnFilters state changes
+    const filteredData = await fetch();
+    setData([...filteredData]);
+  };
+}, [columnFilters]);
+const table = useMaterialReactTable({
+  columns,
+  data, // this will already be filtered on the server
+  manualFiltering: true, //turn off client-side filtering
+  onColumnFiltersChange: setColumnFilters, //hoist internal columnFilters state to your state
+  state: { columnFilters }, //pass in your own managed columnFilters state
+});
+return <MaterialReactTable table={table} />;
+```
+> Specifying `manualFiltering` turns off all client-side filtering and assumes that the `data` you pass to `<MaterialReactTable />` is already filtered.
+See either the [React Query](/docs/examples/react-query) or [useEffect fetching](/docs/examples/remote) examples to see fully server-side **filtering**, pagination, and sorting in action.
+### Customize Material UI Filter components
+You can customize the Material UI filter components by setting the `muiFilterTextFieldProps` table option or column option.
+You can also turn a filter textfield into a select dropdown by setting the `filterSelectOptions` table option or column option.
+<CustomizeFilterComponentsExample />
+### Custom Filter Components
+If you need custom filter components that are much more complex than text-boxes and dropdowns, you can create and pass in your own filter components using the `Filter` column option.
+### Filter Match Highlighting
+Filter Match Highlighting is a new featured enabled by default that will highlight text in the table body cells that matches the current filter query with a shade of the <Box component="span" color="warning.main">`theme.palette.warning.main`</Box> color.
+Filter Match Highlighting will only work on columns with the default `text` filter variant. Also, if you are using a custom `Cell` render override for a column, you will need to use the `renderedCellValue` table option instead of `cell.getValue()` in order to preserve the filter match highlighting.
+```jsx
+const columns = [
+  {
+    accessorKey: 'name',
+    header: 'Name',
+    Cell: ({ renderedCellValue }) => <span>{renderedCellValue}</span>, // use renderedCellValue instead of cell.getValue()
+  },
+];
+```
+#### Disable Filter Match Highlighting
+This feature can be disabled by setting the `enableFilterMatchHighlighting` table option to `false`.
+```jsx
+const table = useMaterialReactTable({
+  columns,
+  data,
+  enableFilterMatchHighlighting: false,
+});
+```
+View Extra Storybook **[Examples](https://www.material-react-table.dev/?path=/story/features-filtering-examples)**