Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: Update the readme #1863

Merged
merged 2 commits into from
Feb 20, 2022
Merged

readme: Update the readme #1863

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18340e0
readme: Update the readme styling example
ashfaqnisar Feb 17, 2022
db95ea1
readme: Updated the compatibility with the required deps
ashfaqnisar Feb 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,23 +37,23 @@ Version 3 has been released! You can read about the [updates here](https://githu

`npm install mui-datatables --save`

If your project doesn't already use them, you need to install `@material-ui/core` and `@material-ui/icons` as well.
If your project doesn't already use them, you need to install `@mui/material`, `@mui/icons-material` as well.

## Compatibility

| mui-datatables | material-ui | Required Dependencies |
|----------------|-------------|------------------------------------------------------|
| ^2.0.0 | ^3.0.0 | `@material-ui/core`,`@material-ui/icons` |
| ^3.0.0 | ^4.10.0 | `@material-ui/core`,`@material-ui/icons` |
| ^3.8.0 | ^4.12.0 | `@material-ui/core`,`@material-ui/icons` |
| ^4.0.0 | ^5.0.0 | `@mui/material`,`@mui/icons-material`, `@mui/styles` |

## Demo

[![Edit react-to-print](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/muidatatables-custom-toolbar-forked-j002q?file=/index.js)

Browse live demos of all examples in this repo in [here](https://codesandbox.io/s/github/gregnb/mui-datatables)!

## compatibility

| mui-datatables | material |
| ------------- | ------------- |
| ^2.0.0 | ^3.0.0 |
| ^3.0.0 | ^4.10.0 |
| ^3.8.0 | ^4.12.0 |
| ^4.0.0 | ^5.0.0 |

## Usage

For a simple table:
Expand Down Expand Up @@ -367,10 +367,12 @@ import { createTheme, ThemeProvider } from '@material-ui/core/styles';
class BodyCellExample extends React.Component {

getMuiTheme = () => createTheme({
overrides: {
components: {
MUIDataTableBodyCell: {
root: {
backgroundColor: "#FF0000"
styleOverrides:{
root: {
backgroundColor: "#FF0000"
}
}
}
}
Expand Down