Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parkerself22/mui-tables
Pluggable table library built on top of Material-UI components
https://github.com/parkerself22/mui-tables
material-design material-ui react react-component react-components reactjs table tables
Last synced: 4 days ago
JSON representation
Pluggable table library built on top of Material-UI components
- Host: GitHub
- URL: https://github.com/parkerself22/mui-tables
- Owner: parkerself22
- License: mit
- Created: 2019-02-09T18:50:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-12T00:53:57.000Z (almost 4 years ago)
- Last Synced: 2025-01-23T23:41:21.337Z (16 days ago)
- Topics: material-design, material-ui, react, react-component, react-components, reactjs, table, tables
- Language: TypeScript
- Homepage: https://parkerself.gitbook.io/mui-table
- Size: 3.28 MB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview \| MUI Tables
[](https://travis-ci.org/parkerself22/mui-tables) [ ](https://www.npmjs.com/package/mui-tables) [](https://codecov.io/gh/parkerself22/mui-table) [](https://www.npmjs.com/package/mui-tables)
### [DOCUMENTATION SITE](https://parkerself.gitbook.io/mui-table/)
MUI Tables is a highly-pluggable table library built on top of the fantastic [Material-UI component library](https://github.com/mui-org/material-ui).
While multiple libraries already provide many of the features included, few \(in my opinion\) provide as much abstraction on top of the data management aspect of building and using tables. The goal for MUI Tables is to make data management as painless as possible while providing as many customization options as possible.
### [**Play with the Configurable Demo here!**](https://parkerself22.github.io/mui-tables/)
## Installation
```bash
npm i --save mui-tables
```
#### Peer Dependencies:
```javascript
{
"@material-ui/core": ">= 3.9.0",
"@material-ui/icons": ">= 3.0.0",
"react": ">= 16.8.1"
}
```
## **Features**
| **Feature** | Description |
| :--- | :--- |
| [Custom Components](docs/features/custom-components.md) | Multiple options to hook into component rendering, all supplied with the full context of the table |
| [Event Hooks](docs/features/event-hooks.md) | Hook into specific table events such as search and filter changes, row selection, and more |
| Summary Row | No config required summary row with two formats, more on the way. |
| [Automatic Duplicate Handling](docs/features/row-merging-and-duplication.md) | Specify whether duplicate rows should be displayed, merged, or hidden. |
| Built In Date Toolbar | No custom toolbar required, just specify change handlers and date values. |
| Localization | Full control over almost every text label. |
| Typescript Support | Typings included. Never guess what data you're hooks will be passed. |
| Styling | Override styles using MUIThemeProvider. |
## Example Usage
```jsx
import React from 'react';
import MUITable from 'mui-tables';
const data = [
{ name: 'Bob', demographics: { age: 29, gender: "male" } },
{ name: 'Alice', demographics: { age: 34, gender: "female" } }
];
const columns = {
static: [
{
name: 'name',
title: 'Name',
calculateCellDefinition: (entry) => ({
display: entry.name,
value: entry.name
})
},
{
name: 'age',
title: 'Age',
calculateCellDefinition: (entry) => ({
// Never ask a woman's age fool!
display: entry.demographics.gender === "female" ? "❓" : entry.demographics.age,
value: entry.demographics.age
})
}
]
};
export const IntroExample = () => (
);
```
## Props / Options
[See Here](docs/options/options.md)
## Built With
* [@material-ui](https://material-ui.com) - Component Library
* [material-ui-pickers](https://www.npmjs.com/package/material-ui-pickers) - Date Picker Components
## Contributing
Coming soon...
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, [see the releases on this repository](https://github.com/parkerself22/mui-tables/releases).
## Authors
* [**Parker Self**](https://github.com/parkerself22) - _Initial work_
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/parkerself22/mui-tables/blob/master/LICENSE) file for details