File tree Expand file tree Collapse file tree 3 files changed +16
-16
lines changed
Expand file tree Collapse file tree 3 files changed +16
-16
lines changed Original file line number Diff line number Diff line change @@ -4,19 +4,19 @@ import ErrorState from '../ErrorState';
44import ErrorStack from '../ErrorStack' ;
55
66export interface ErrorPageProps {
7- /** Title to display on the error page */
7+ /** The title text to display on the error page */
88 headerTitle : string ;
9- /** Indicates if this is a silent error */
9+ /** Indicates if the error is silent */
1010 silent ?: boolean ;
11- /** Title given to the error */
11+ /** The title text to display with the error */
1212 errorTitle ?: string ;
13- /** A description of the error */
13+ /** The description text to display with the error */
1414 errorDescription ?: React . ReactNode ;
15- /** Text to display when error is closed. */
15+ /** The text for the toggle link that users can select to view error details */
1616 errorToggleText ?: string ;
17- /** A default description of the error used if no errorDescription is provided. */
17+ /** The default description text to display with the error if no errorDescription is provided */
1818 defaultErrorDescription ?: React . ReactNode ;
19- /** Children components */
19+ /** The component that the error boundary component is wrapped around, which should be returned if there is no error */
2020 children ?: React . ReactNode ;
2121}
2222
Original file line number Diff line number Diff line change @@ -4,13 +4,13 @@ import NotFoundIcon from '../NotFoundIcon/NotFoundIcon';
44import React from 'react' ;
55
66export interface InvalidObjectProps extends React . DetailedHTMLProps < React . HTMLAttributes < HTMLElement > , HTMLElement > {
7- /** Custom landing page button URL */
7+ /** The URL that the landing page link points to */
88 toLandingPageUrl ?: string ;
9- /** Custom return to landing page text */
9+ /** The text label for the link that points back to the landing page */
1010 toLandingPageText ?: React . ReactNode ;
11- /** Custom invalid page title text */
11+ /** The title for the invalid object message */
1212 invalidObjectTitleText ?: string ;
13- /** Custom invalid page body text */
13+ /** The body text for the invalid object message */
1414 invalidObjectBodyText ?: string ;
1515}
1616
Original file line number Diff line number Diff line change @@ -15,15 +15,15 @@ const useStyles = createUseStyles({
1515} ) ;
1616
1717export interface UnavailableContentProps {
18- /** Page to open when user clicks on status page link */
18+ /** The URL that the status page link points to */
1919 statusPageUrl ?: string ;
20- /** Status page link text */
20+ /** The text label for the link that points to the status page */
2121 statusPageLinkText ?: string ;
22- /** Unavailable page title text */
22+ /** The title for the unavailable content message */
2323 unavailableTitleText ?: string ;
24- /** Unavailable page body text before status page link */
24+ /** The body text for the unavailable content message that appears before the status page link */
2525 unavailableBodyPreStatusLinkText ?: string ;
26- /** Unavailable page body text after status page link */
26+ /** The body text for the unavailable content message that appears after the status page link */
2727 unavailableBodyPostStatusLinkText ?: string ;
2828}
2929
You can’t perform that action at this time.
0 commit comments