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

[Doc] Improve List and Datagrid docs #5449

Merged
merged 2 commits into from
Oct 29, 2020
Merged

[Doc] Improve List and Datagrid docs #5449

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4758b8b
Improve List and Datagrid docs
Oct 28, 2020
0e1a208
Fix Datagrid css rules descriptions
Oct 28, 2020
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
27 changes: 15 additions & 12 deletions docs/List.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,10 +734,11 @@ The `List` component accepts the usual `className` prop but you can override man
| `bulkActionsDisplayed` | Applied to the child component inside the main container when there are selected records |
| `noResults` | Applied to the component shown when there is no result |

You can customize the list styles by passing a `classes` object as prop, through `useStyles()`. Here is an example:
You can customize the `<List>` styles by passing a `classes` object as prop, through `useStyles()`. Here is an example:

{% raw %}
```jsx
import * as React from 'react';
import { makeStyles } from '@material-ui/core';

const useStyles = makeStyles({
Expand Down Expand Up @@ -2033,21 +2034,21 @@ export const PostList = props => (

The `Datagrid` component accepts the usual `className` prop but you can override many class names injected to the inner components by React-admin thanks to the `classes` property (as most Material UI components, see their [documentation about it](https://material-ui.com/customization/components/#overriding-styles-with-classes)). This property accepts the following keys:

* `table`: alternative to using `className`. Applied to the root element.
* `tbody`: applied to the tbody
* `headerCell`: applied to each header cell
* `row`: applied to each row
* `rowEven`: applied to each even row
* `rowOdd`: applied to each odd row
* `rowCell`: applied to each row cell

Here is an example of how you can override some of these classes:
| Rule name | Description |
| ------------- | ------------------------------------------------------------- |
| `table` | Alternative to using `className`. Applied to the root element |
| `tbody` | Applied to the tbody |
| `headerCell` | Applied to each header cell |
| `row` | Applied to each row |
| `rowEven` | Applied to each even row |
| `rowOdd` | Applied to the each odd row |
| `rowCell` | Applied to the each row cell |

You can customize the `<Datagrid>` styles by passing a `classes` object as prop, through `useStyles()`. Here is an example:

{% raw %}
```jsx
import * as React from "react";
import * as React from 'react';
import { makeStyles } from '@material-ui/core';

const useStyles = makeStyles({
Expand All @@ -2071,6 +2072,8 @@ export default PostList;
```
{% endraw %}

**Tip**: The `Datagrid` component `classes` can also be customized for all instances of the component with its global css name `"RaDatagrid"` as [describe here](https://marmelab.com/blog/2019/12/18/react-admin-3-1.html#theme-overrides)

**Tip**: If you want to override the `header` and `cell` styles independently for each column, use the `headerClassName` and `cellClassName` props in `<Field>` components. For instance, to hide a certain column on small screens:

```jsx
Expand Down Expand Up @@ -2181,7 +2184,7 @@ const CustomList = () => {
<ListContextProvider
value={{
resource: 'posts',
basePath: 'posts',
basePath: '/posts',
data: keyBy(data, 'id'),
ids: data.map(({ id }) => id),
currentSort: { field: 'id', order: 'ASC' },
Expand Down