Skip to content

Commit

Permalink
Updated with docuemnetation review comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
dlabaj committed Dec 4, 2023
1 parent 6d3a81f commit cea2386
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
14 changes: 7 additions & 7 deletions packages/module/src/ErrorBoundary/ErrorBoundary.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ import ErrorState from '../ErrorState';
import ErrorStack from '../ErrorStack';

export interface ErrorPageProps {
/** Title to display on the error page */
/** The title text to display on the error page */
headerTitle: string;
/** Indicates if this is a silent error */
/** Indicates if the error is silent */
silent?: boolean;
/** Title given to the error */
/** The title text to display with the error */
errorTitle?: string;
/** A description of the error */
/** The description text to display with the error */
errorDescription?: React.ReactNode;
/** Text to display when error is closed. */
/** The text for the toggle link that users can select to view error details */
errorToggleText?: string;
/** A default description of the error used if no errorDescription is provided. */
/** The default description text to display with the error if no errorDescription is provided */
defaultErrorDescription?: React.ReactNode;
/** Children components */
/** The component that the error boundary component is wrapped around, which should be returned if there is no error */
children?: React.ReactNode;
}

Expand Down
8 changes: 4 additions & 4 deletions packages/module/src/InvalidObject/InvalidObject.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ import NotFoundIcon from '../NotFoundIcon/NotFoundIcon';
import React from 'react';

export interface InvalidObjectProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
/** Custom landing page button URL */
/** The URL that the landing page link points to */
toLandingPageUrl?: string;
/** Custom return to landing page text */
/** The text label for the link that points back to the landing page */
toLandingPageText?: React.ReactNode;
/** Custom invalid page title text */
/** The title for the invalid object message */
invalidObjectTitleText?: string;
/** Custom invalid page body text */
/** The body text for the invalid object message */
invalidObjectBodyText?: string;
}

Expand Down
10 changes: 5 additions & 5 deletions packages/module/src/UnavailableContent/UnavailableContent.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ const useStyles = createUseStyles({
});

export interface UnavailableContentProps {
/** Page to open when user clicks on status page link */
/** The URL that the status page link points to */
statusPageUrl?: string;
/** Status page link text */
/** The text label for the link that points to the status page */
statusPageLinkText?: string;
/** Unavailable page title text */
/** The title for the unavailable content message */
unavailableTitleText?: string;
/** Unavailable page body text before status page link */
/** The body text for the unavailable content message that appears before the status page link */
unavailableBodyPreStatusLinkText?: string;
/** Unavailable page body text after status page link */
/** The body text for the unavailable content message that appears after the status page link */
unavailableBodyPostStatusLinkText?: string;
}

Expand Down

0 comments on commit cea2386

Please sign in to comment.