Security News
CISA Brings KEV Data to GitHub
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
material-react-table
Advanced tools
A fully featured Material UI V6 implementation of TanStack React Table V8, written from the ground up in TypeScript.
The material-react-table npm package is a powerful and flexible data table component for React applications, built with Material-UI. It provides a wide range of features for displaying, sorting, filtering, and editing tabular data.
Basic Table
This code demonstrates how to create a basic table using the material-react-table package. It defines a set of columns and data, and then renders the table with these configurations.
import React from 'react';
import MaterialReactTable from 'material-react-table';
const data = [
{ id: 1, name: 'John Doe', age: 28 },
{ id: 2, name: 'Jane Smith', age: 34 },
];
const columns = [
{ title: 'ID', field: 'id' },
{ title: 'Name', field: 'name' },
{ title: 'Age', field: 'age' },
];
const BasicTable = () => (
<MaterialReactTable
columns={columns}
data={data}
/>
);
export default BasicTable;
Sorting
This code demonstrates how to enable sorting on columns in the material-react-table. By setting the 'sorting' property to true in the column definitions, users can sort the table data by clicking on the column headers.
import React from 'react';
import MaterialReactTable from 'material-react-table';
const data = [
{ id: 1, name: 'John Doe', age: 28 },
{ id: 2, name: 'Jane Smith', age: 34 },
];
const columns = [
{ title: 'ID', field: 'id', sorting: true },
{ title: 'Name', field: 'name', sorting: true },
{ title: 'Age', field: 'age', sorting: true },
];
const SortableTable = () => (
<MaterialReactTable
columns={columns}
data={data}
options={{ sorting: true }}
/>
);
export default SortableTable;
Filtering
This code demonstrates how to enable filtering on columns in the material-react-table. By setting the 'filtering' property to true in the column definitions, users can filter the table data using input fields in the column headers.
import React from 'react';
import MaterialReactTable from 'material-react-table';
const data = [
{ id: 1, name: 'John Doe', age: 28 },
{ id: 2, name: 'Jane Smith', age: 34 },
];
const columns = [
{ title: 'ID', field: 'id', filtering: true },
{ title: 'Name', field: 'name', filtering: true },
{ title: 'Age', field: 'age', filtering: true },
];
const FilterableTable = () => (
<MaterialReactTable
columns={columns}
data={data}
options={{ filtering: true }}
/>
);
export default FilterableTable;
Editable Table
This code demonstrates how to create an editable table using the material-react-table package. By setting the 'editable' property in the column definitions, users can edit the table data directly in the table cells.
import React from 'react';
import MaterialReactTable from 'material-react-table';
const data = [
{ id: 1, name: 'John Doe', age: 28 },
{ id: 2, name: 'Jane Smith', age: 34 },
];
const columns = [
{ title: 'ID', field: 'id', editable: 'never' },
{ title: 'Name', field: 'name', editable: 'onUpdate' },
{ title: 'Age', field: 'age', editable: 'onUpdate' },
];
const EditableTable = () => (
<MaterialReactTable
columns={columns}
data={data}
editable={{
onRowUpdate: (newData, oldData, resolve) => {
// Update logic here
resolve();
},
}}
/>
);
export default EditableTable;
material-table is a popular data table component for React that integrates with Material-UI. It offers similar functionalities to material-react-table, such as sorting, filtering, and editing. However, material-table has a larger community and more extensive documentation.
react-table is a lightweight and flexible table library for React. While it does not come with built-in Material-UI integration, it provides a highly customizable API for building tables with features like sorting, filtering, and pagination. It requires more manual setup compared to material-react-table.
mui-datatables is another data table component for React that integrates with Material-UI. It offers a wide range of features, including sorting, filtering, and editing, similar to material-react-table. mui-datatables is known for its ease of use and comprehensive feature set.
View Documentation
Want to use Mantine instead of Material UI? Check out Mantine React Table
View additional storybook examples
All features can easily be enabled/disabled
Fully Fleshed out Docs are available for all features
View the full Installation Docs
Ensure that you have React 18 or later installed
Install Peer Dependencies (Material UI V6)
npm install @mui/material @mui/x-date-pickers @mui/icons-material @emotion/react @emotion/styled
npm install material-react-table
@tanstack/react-table
,@tanstack/react-virtual
, and@tanstack/match-sorter-utils
are internal dependencies, so you do NOT need to install them yourself.
Read the full usage docs here
import { useMemo, useState, useEffect } from 'react';
import {
MaterialReactTable,
useMaterialReactTable,
} from 'material-react-table';
//data must be stable reference (useState, useMemo, useQuery, defined outside of component, etc.)
const data = [
{
name: 'John',
age: 30,
},
{
name: 'Sara',
age: 25,
},
];
export default function App() {
const columns = useMemo(
() => [
{
accessorKey: 'name', //simple recommended way to define a column
header: 'Name',
muiTableHeadCellProps: { sx: { color: 'green' } }, //optional custom props
Cell: ({ cell }) => <span>{cell.getValue()}</span>, //optional custom cell render
},
{
accessorFn: (row) => row.age, //alternate way
id: 'age', //id required if you use accessorFn instead of accessorKey
header: 'Age',
Header: () => <i>Age</i>, //optional custom header render
},
],
[],
);
//optionally, you can manage any/all of the table state yourself
const [rowSelection, setRowSelection] = useState({});
useEffect(() => {
//do something when the row selection changes
}, [rowSelection]);
const table = useMaterialReactTable({
columns,
data,
enableColumnOrdering: true, //enable some features
enableRowSelection: true,
enablePagination: false, //disable a default feature
onRowSelectionChange: setRowSelection, //hoist internal state to your own state (optional)
state: { rowSelection }, //manage your own state, pass it back to the table (optional)
});
const someEventHandler = () => {
//read the table state during an event from the table instance
console.log(table.getState().sorting);
};
return (
<MaterialReactTable table={table} /> //other more lightweight MRT sub components also available
);
}
Open in Code Sandbox
PRs are Welcome, but please discuss in GitHub Discussions or the Discord Server first if it is a large change!
Read the Contributing Guide to learn how to run this project locally.
FAQs
A fully featured Material UI V6 implementation of TanStack React Table V8, written from the ground up in TypeScript.
The npm package material-react-table receives a total of 101,922 weekly downloads. As such, material-react-table popularity was classified as popular.
We found that material-react-table demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
Security News
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.