material-table

Datatable for React based on material-ui's table with additional features

ReactMaterial designTable
mbrn/material-tablematerial-table.commaterial-table

README

:warning: Please do not create pull requests that contains a lot of change. Because we are working on refactoring and testing. Just pull requests that fixes a bug with a few line changes.




material-table

material-table


A simple and powerful Datatable for React based on Material-UI Table with some additional features.
Build Status Financial Contributors on Open Collective npm package NPM Downloads Average time to resolve an issue xscode Follow on Twitter Gitter chat


Roadmap


- More on our roadmap can be found here

Key features


- Actions
- Component overriding
- Custom column rendering
- Detail Panel
- Editable
- Export
- Filtering
- Grouping
- Localization
- Remote Data
- Search
- Selection
- Sorting
- Styling
- Tree Data
- and more

Demo and documentation


You can access all code examples and documentation on our site [material-table.com](https://material-table.com/).

Support material-table


To support material-table visit SUPPORT page.

Issue Prioritizing


Issues would be prioritized according reactions count. is:issue is:open sort:reactions-+1-desc filter would be use.

List issues according to reaction score

Prerequisites


The minimum React version material-table supports is ^16.8.5 since material-table v1.36.1. This is due to utilising [react-beautiful-dnd](https://github.com/atlassian/react-beautiful-dnd) for drag & drop functionality which uses hooks.

If you use an older version of react we suggest to upgrade your dependencies or use material-table 1.36.0.

Installation


1.Install package


To install material-table with npm:

    npm install material-table @material-ui/core --save

To install material-table with yarn:

    yarn add material-table @material-ui/core

2.Add material icons


There are two ways to use icons in material-table either import the material icons font via html OR import material icons and use the material-table icons prop.

HTML

  1. ``` html
  2. <link
  3.   rel="stylesheet"
  4.   href="https://fonts.googleapis.com/icon?family=Material+Icons"
  5. />
  6. ```

OR

Import Material icons

Icons can be imported to be used in material-table offering more flexibility for customising the look and feel of material table over using a font library.

To install @material-ui/icons with npm:

    npm install @material-ui/icons --save

To install @material-ui/icons with yarn:

    yarn add @material-ui/icons

If your environment doesn't support tree-shaking, the recommended way to import the icons is the following:

  1. ``` js
  2. import AddBox from "@material-ui/icons/AddBox";
  3. import ArrowDownward from "@material-ui/icons/ArrowDownward";
  4. ```

If your environment support tree-shaking you can also import the icons this way:

  1. ``` js
  2. import { AddBox, ArrowDownward } from "@material-ui/icons";
  3. ```

Note: Importing named exports in this way will result in the code for _every icon_ being included in your project, so is not recommended unless you configure tree-shaking. It may also impact Hot Module Reload performance. Source: @material-ui/icons

Example

  1. ``` js
  2. import { forwardRef } from 'react';

  4. import AddBox from '@material-ui/icons/AddBox';
  5. import ArrowDownward from '@material-ui/icons/ArrowDownward';
  6. import Check from '@material-ui/icons/Check';
  7. import ChevronLeft from '@material-ui/icons/ChevronLeft';
  8. import ChevronRight from '@material-ui/icons/ChevronRight';
  9. import Clear from '@material-ui/icons/Clear';
  10. import DeleteOutline from '@material-ui/icons/DeleteOutline';
  11. import Edit from '@material-ui/icons/Edit';
  12. import FilterList from '@material-ui/icons/FilterList';
  13. import FirstPage from '@material-ui/icons/FirstPage';
  14. import LastPage from '@material-ui/icons/LastPage';
  15. import Remove from '@material-ui/icons/Remove';
  16. import SaveAlt from '@material-ui/icons/SaveAlt';
  17. import Search from '@material-ui/icons/Search';
  18. import ViewColumn from '@material-ui/icons/ViewColumn';

  20. const tableIcons = {
  21.     Add: forwardRef((props, ref) => <AddBox {...props} ref={ref} />),
  22.     Check: forwardRef((props, ref) => <Check {...props} ref={ref} />),
  23.     Clear: forwardRef((props, ref) => <Clear {...props} ref={ref} />),
  24.     Delete: forwardRef((props, ref) => <DeleteOutline {...props} ref={ref} />),
  25.     DetailPanel: forwardRef((props, ref) => <ChevronRight {...props} ref={ref} />),
  26.     Edit: forwardRef((props, ref) => <Edit {...props} ref={ref} />),
  27.     Export: forwardRef((props, ref) => <SaveAlt {...props} ref={ref} />),
  28.     Filter: forwardRef((props, ref) => <FilterList {...props} ref={ref} />),
  29.     FirstPage: forwardRef((props, ref) => <FirstPage {...props} ref={ref} />),
  30.     LastPage: forwardRef((props, ref) => <LastPage {...props} ref={ref} />),
  31.     NextPage: forwardRef((props, ref) => <ChevronRight {...props} ref={ref} />),
  32.     PreviousPage: forwardRef((props, ref) => <ChevronLeft {...props} ref={ref} />),
  33.     ResetSearch: forwardRef((props, ref) => <Clear {...props} ref={ref} />),
  34.     Search: forwardRef((props, ref) => <Search {...props} ref={ref} />),
  35.     SortArrow: forwardRef((props, ref) => <ArrowDownward {...props} ref={ref} />),
  36.     ThirdStateCheck: forwardRef((props, ref) => <Remove {...props} ref={ref} />),
  37.     ViewColumn: forwardRef((props, ref) => <ViewColumn {...props} ref={ref} />)
  38.   };

  40. <MaterialTable
  41.   icons={tableIcons}
  42.   ...
  43. />
  44. ```

Usage


Here is a basic example of using material-table within a react application.

  1. ``` js
  2. import React, { Component } from "react";
  3. import ReactDOM from "react-dom";
  4. import MaterialTable from "material-table";

  6. class App extends Component {
  7.   render() {
  8.     return (
  9.       <div style={{ maxWidth: "100%" }}>
  10.         <MaterialTable
  11.           columns={[
  12.             { title: "Adı", field: "name" },
  13.             { title: "Soyadı", field: "surname" },
  14.             { title: "Doğum Yılı", field: "birthYear", type: "numeric" },
  15.             {
  16.               title: "Doğum Yeri",
  17.               field: "birthCity",
  18.               lookup: { 34: "İstanbul", 63: "Şanlıurfa" },
  19.             },
  20.           ]}
  21.           data={[
  22.             {
  23.               name: "Mehmet",
  24.               surname: "Baran",
  25.               birthYear: 1987,
  26.               birthCity: 63,
  27.             },
  28.           ]}
  29.           title="Demo Title"
  30.         />
  31.       </div>
  32.     );
  33.   }
  34. }

  36. ReactDOM.render(<App />, document.getElementById("react-div"));
  37. ```

Contributing


We'd love to have your helping hand on material-table! See CONTRIBUTING.md for more information on what we're looking for and how to get started.

If you have any sort of doubt, idea or just want to talk about the project, feel free to join our chat on Gitter :)

Contributors


Code Contributors


This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors


Become a financial contributor and help us sustain our community. [Contribute]

Individuals



Organizations


Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]


License


This project is licensed under the terms of the MIT license.