Janekk/material-react-table

A fully featured Material UI V5 implementation of TanStack Table V8, inspired by material-table, written from the ground up in TypeScript

★ 0Forks 0GitHub ↗Compare

Project website ↗

README

Material React Table


This Project is based on @tanstack/react-table v8, which itself is still in beta, so therefore this package is also still in alpha/beta

  • A fully featured Material UI V5 implementation of Tanstack React Table v8 (beta)
  • Inspired by material-table and the MUI X DataGrid
  • Written from the ground up in TypeScript, Material UI, and React Table
  • All internal Material UI components are easily customizable

This project is in alpha, but will go into beta soonTM, so feel free to install and explore

View the docs (alpha) site

View a basic example

View additional storybook examples

View the github source code and github open issues

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


Features (All Features work and are MVP, but are still being polished)

All features can easily be enabled/disabled

  • Click To Copy Cell Values
  • Column Actions
  • Column Grouping (Group By and Aggregates)
  • Column Hiding
  • Column Ordering via Drag'n'Drop (react-dnd)
  • Column Pinning
  • Column Resizing (work in progress)
  • Customize Icons
  • Customize Styling of internal Mui Components
  • Data Editing (3 different editing modes)
  • Density Toggle
  • Detail Panels
  • Filtering and multiple built-in filter modes
  • Full Screen mode
  • Global Filtering (Search across all columns, rank by best match)
  • Header Groups & Footers
  • Localization (i18n) support
  • Manage your own state
  • Pagination (supports client-side and server-side)
  • Persistent State
  • Row Actions
  • Row Numbers
  • Row Selection (checkboxes)
  • SSR compatible
  • Sorting
  • Theming (Respects your Material UI Theme)
  • Toolbars (Add your own action buttons)
  • Tree Data / Expanding Sub-rows
  • Virtualization (react-virtual)

Installation

  1. Install Peer Dependencies (Material UI v5)
npm install @mui/material @mui/icons-material @emotion/react @emotion/styled
  1. Install material-react-table
npm install material-react-table

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


Contributors

PRs are Welcome, but please discuss in GitHub Discussions or the Discord Server first!

Contributors

KevinVandyoliviertassinariryanmk54

Issues