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

Add links to the Error page to help resolution #6367

Merged
merged 1 commit into from
Jun 17, 2021
Merged

Add links to the Error page to help resolution #6367

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
76 changes: 57 additions & 19 deletions packages/ra-ui-materialui/src/layout/Error.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ import * as React from 'react';
import { Fragment, HtmlHTMLAttributes, ErrorInfo } from 'react';
import PropTypes from 'prop-types';
import classnames from 'classnames';
import Button from '@material-ui/core/Button';
import Accordion from '@material-ui/core/Accordion';
import AccordionDetails from '@material-ui/core/AccordionDetails';
import AccordionSummary from '@material-ui/core/AccordionSummary';
import {
Button,
Accordion,
AccordionDetails,
AccordionSummary,
Typography,
} from '@material-ui/core';
import { makeStyles } from '@material-ui/core/styles';
import ErrorIcon from '@material-ui/icons/Report';
import ExpandMoreIcon from '@material-ui/icons/ExpandMore';
Expand Down Expand Up @@ -39,13 +42,17 @@ const useStyles = makeStyles(
},
panel: {
marginTop: '1em',
maxWidth: '60em',
},
panelDetails: {
whiteSpace: 'pre-wrap',
},
toolbar: {
marginTop: '2em',
},
advice: {
marginTop: '2em',
},
}),
{ name: 'RaError' }
);
Expand All @@ -65,6 +72,7 @@ const Error = (props: ErrorProps): JSX.Element => {
} = props;
const classes = useStyles(props);
const translate = useTranslate();

return (
<Fragment>
{title && <Title defaultTitle={title} />}
Expand All @@ -75,21 +83,51 @@ const Error = (props: ErrorProps): JSX.Element => {
</h1>
<div>{translate('ra.message.error')}</div>
{process.env.NODE_ENV !== 'production' && (
<Accordion className={classes.panel}>
<AccordionSummary expandIcon={<ExpandMoreIcon />}>
{translate('ra.message.details')}
</AccordionSummary>
<AccordionDetails className={classes.panelDetails}>
<div>
<h2>
{translate(error.toString(), {
_: error.toString(),
})}
</h2>
{errorInfo && errorInfo.componentStack}
</div>
</AccordionDetails>
</Accordion>
<>
<Accordion className={classes.panel}>
<AccordionSummary expandIcon={<ExpandMoreIcon />}>
{translate(error.toString(), {
_: error.toString(),
})}
</AccordionSummary>
{errorInfo && (
<AccordionDetails
className={classes.panelDetails}
>
{errorInfo.componentStack}
</AccordionDetails>
)}
</Accordion>

<div className={classes.advice}>
<Typography align="center">
Need help with this error? Try the following:
</Typography>
<Typography component="div">
<ul>
<li>
Check the{' '}
<a href="https://marmelab.com/react-admin/Readme.html">
react-admin documentation
</a>
</li>
<li>
Search on{' '}
<a href="https://stackoverflow.com/questions/tagged/react-admin">
StackOverflow
</a>{' '}
for community answers
</li>
<li>
Get help from the core team via{' '}
<a href="https://marmelab.com/ra-enterprise/#fromsww">
react-admin Enterprise Edition
</a>
</li>
</ul>
</Typography>
</div>
</>
)}
<div className={classes.toolbar}>
<Button
Expand Down