donerdev / material-react-table Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kevinvandy/material-react-table

0.0 0.0 0.0 7.25 MB

A fully featured Material UI V5 implementation of TanStack React Table V8, written from the ground up in TypeScript

Home Page: https://material-react-table.com

License: MIT License

JavaScript 11.16% TypeScript 87.14% CSS 0.06% HTML 1.64%

material-react-table's Introduction

Material React Table

About

Version 1.0 released 2022-09-13 🎉

Built with Material UI ^V5 and TanStack Table ^V8

Quickly Create React Data Tables with Material Design

Full Localization (i18n) Support!

Join the Discord server to join in on the development discussion or ask questions

View the Docs Website

See all Props, Options, and APIs

Quick Examples

Basic Table (See Default Features)
Minimal Table (Turn off Features like Pagination, Sorting, Filtering, and Toolbars)
Advanced Table (See some of the Advanced Features)
Aggregation/Grouping (Aggregation features such as Sum, Average, Count, etc.)
Data Export Table (Export to CSV, Excel, etc.)
Editing CRUD Table (Create, Edit, and Delete Rows)
Remote Data (Server-side Pagination, Sorting, and Filtering)
React Query (Server-side Pagination, Sorting, and Filtering)
Virtualized Rows (10,000 rows at once!)
Infinite Scrolling (Fetch data as you scroll)

View additional storybook examples

Features

All features can easily be enabled/disabled

Fully Fleshed out Docs are available for all features

Getting Started

Installation

View the full Installation Docs

Ensure that you have React 17 or later installed (MUI V5 requires React 17 or 18)
Install Peer Dependencies (Material UI V5)

npm install @mui/material @mui/icons-material @emotion/react @emotion/styled

Install material-react-table

npm install material-react-table

@tanstack/react-table, @tanstack/react-virtual, and @tanstack/match-sorter-utils are internal dependencies, so you don't need to install them yourself.

Usage

Read the full usage docs here

import React, { useMemo, useRef, useState, useEffect } from 'react';
import MaterialReactTable from 'material-react-table';

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]);

  //Or, optionally, you can get a reference to the underlying table instance
  const tableInstanceRef = useRef(null);

  const someEventHandler = () => {
    //read the table state during an event from the table instance ref
    console.log(tableInstanceRef.current.getState().sorting);
  }

  return (
    <MaterialReactTable 
      columns={columns} 
      data={data} 
      enableColumnOrdering //enable some features
      enableRowSelection 
      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)
      tableInstanceRef={tableInstanceRef} //get a reference to the underlying table instance (optional)
    />
  );
}