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

Jump to bottom

[Doc] Fix Theming doc uses outdated syntax for conditional formatting example #7799

Merged
merged 1 commit into from
Jun 8, 2022
Merged

[Doc] Fix Theming doc uses outdated syntax for conditional formatting example #7799

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 10 additions & 59 deletions docs/Theming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,73 +398,24 @@ const ThemeToggler = () => {

## Conditional Formatting

Sometimes you want the format to depend on the value. The following example shows how to create a new custom `NumberField` component which highlight its text in red when its value is 100 or higher.
Sometimes you want the format to depend on the value. Use `useRecordContext` to grab the record in a component, and the `sx` prop to apply the format.

{% raw %}
```jsx
import * as React from 'react';
import { NumberField, List, Datagrid, TextField, EditButton } from 'react-admin';

const ColoredNumberFieldStyles = {
small: { color: 'black' },
big: { color: 'red' },
};

const ColoredNumberField = (props) => (
<NumberField
sx={{
...(props.record[props.source] < 100 &&
ColoredNumberFieldStyles.small),
...(props.record[props.source] >= 100 &&
ColoredNumberFieldStyles.big),
}}
{...props}
/>
);

// Ensure the original component defaultProps are still applied as they may be used by its parents (such as the `Show` component):
ColoredNumberField.defaultProps = NumberField.defaultProps;

export const PostList = () => (
<List>
<Datagrid>
<TextField source="id" />
...
<ColoredNumberField source="nb_views" />
<EditButton />
</Datagrid>
</List>
);
```
{% endraw %}

Furthermore, you may extract this highlighting strategy into a Higher Order Component if you'd like to reuse it for other components as well:
The following example shows how to create a new `<ColoredNumberField>` component, which renders with red text when its value is less than 0.

{% raw %}
```jsx
import * as React from 'react';
import { NumberField, List, Datagrid, TextField, EditButton } from 'react-admin';
import { iseRecordContext, NumberField, List, Datagrid, TextField, EditButton } from 'react-admin';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fzaninotto , Actually looks like a typo on iseRecordContext

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, can you open a PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#7802


const ColoredNumberFieldStyles = {
small: { color: 'black' },
big: { color: 'red' },
};

const colored = (WrappedComponent) => (props) =>
(
<WrappedComponent
sx={{
...(props.record[props.source] < 100 &&
ColoredNumberFieldStyles.small),
...(props.record[props.source] >= 100 &&
ColoredNumberFieldStyles.big),
}}
const ColoredNumberField = (props) => {
const record = useRecordContext();
return (
<NumberField
sx={{ color: record[prop.source] < 0 ? 'red' : 'black' }}
{...props}
/>
);
};


const ColoredNumberField = colored(NumberField);
// Ensure the original component defaultProps are still applied as they may be used by its parents (such as the `Show` component):
ColoredNumberField.defaultProps = NumberField.defaultProps;

Expand All @@ -481,7 +432,7 @@ export const PostList = () => (
```
{% endraw %}

If you want to read more about higher-order components, check out this SitePoint tutorial: [Higher Order Components: A React Application Design Pattern](https://www.sitepoint.com/react-higher-order-components/)
**Tip**: if you don't want to create a custom component to apply conditional formatting, you can also use [the `<WithRecord>` component](./WithRecord.md)].

## `useMediaQuery` Hook

Expand Down