Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oze4/material-table-core

Maintained Fork of mbrn/material-table - Datatable for React based on material-ui's table with additional features
https://github.com/oze4/material-table-core

Last synced: 2 months ago
JSON representation

Maintained Fork of mbrn/material-table - Datatable for React based on material-ui's table with additional features

Awesome Lists containing this project

README

        

# THIS PROJECT IS NOT MANTAINED HERE

### WE'VE MOVED TO [@material-table/core](https://github.com/material-table-core/core)

----

----

----

@material-table/core







🚧 Documentation, including this `README`, is a work in progress 🚧

✅ The code here is *at least* as stable as `material-table` `v1.57.2` ✅

- [Please check out `material-table` here](https://github.com/mbrn/material-table)
- [Why does this repo exist?...and more here](/.github/MoreInfo.md)

---

# Table of Contents

[https://material-table-core.com](https://material-table-core.com)

- [Compatibility with `material-table`](#compatibility)
- [Installation](#installation)
- [Examples](https://oze4.github.io/material-table-core/)
- [Documentation](#documentation)
- [`npm` Commands](#npm-commands)
- [`material-table` Issue Tracker](https://oze4.github.io/material-table-core/#/issue-tracker)
- [To-Do List](https://oze4.github.io/material-table-core/#/to-do)
- [Contributing](#contributing)
- [Demo Documentation](/.github/DemoDocumentation.md)

---

## Compatibility

Our main goal is to resolve current open issues over at `material-table`. Therefore, we are not backwards compatible. [See here for more info on our goals, etc..](/.github/MoreInfo.md)

With that being said, we will not be modifying component names or making drastic changes to the API/structure - imports will remain the same, etc..

## Installation

- `npm install @material-table/core`
- `yarn add @material-table/core`

```javascript
// If you can import it from `material-table` you
// can import it from `@material-table/core`
import MaterialTable from "@material-table/core";
```

## Documentation

For now, the existing material-table docs are valid.

- [material-table README](https://github.com/mbrn/material-table/blob/master/README.md)
- [material-table API Documentation](https://material-table.com)
- [Demo Documentation](/.github/DemoDocumentation.md)

## npm Commands

*make sure you are at the root of the project

| Command | Purpose | Notes |
| --- | --- | --- |
| `npm start` | Runs demo | Listens on port `:8080` |
| `npm run build:demo` | Bundles the demo | Outputs to `/docs`. After making changes to the demo, you'll need to run this |
| `npm run update:issue:tracker` | Update Issue Tracker with newly resolved issues | Searches `material-table` pull requests and issues for any comment that contains `/mtc::resolved`. [More info can be found here](/.github/DemoDocumentation.md#issue-tracker-documentation) |

## Contributing

Gladly accepting "applications" :) ..but seriously, my main goal is to be responsive... I have no issue giving access/permission to those that wish to help improve this excellent product! [Demo documentation can be found here](/.github/DemoDocumentation.md)