Added documentation for ErrorState.

dlabaj · dlabaj · commit 05917ab80601 · 2023-01-05T16:31:08.000-05:00
diff --git a/packages/module/src/ErrorState/ErrorState.tsx b/packages/module/src/ErrorState/ErrorState.tsx
@@ -15,7 +15,9 @@ import {
 import './error-state.scss';
 
 export interface ErrorStateProps extends Omit<EmptyStateProps, 'children'> {
+  /** Title of the error. */
   errorTitle?: string;
+  /** A description of the error, if no description is provided then it will be set to the default message. */
   errorDescription?: React.ReactNode;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,9 @@ import {`
`15`	`15`	`import './error-state.scss';`
`16`	`16`
`17`	`17`	`export interface ErrorStateProps extends Omit<EmptyStateProps, 'children'> {`
	`18`	`+ /** Title of the error. */`
`18`	`19`	`errorTitle?: string;`
	`20`	`+ /** A description of the error, if no description is provided then it will be set to the default message. */`
`19`	`21`	`errorDescription?: React.ReactNode;`
`20`	`22`	`}`
`21`	`23`