diff --git a/login-workflow/src/components/ChangePasswordDialog/types.ts b/login-workflow/src/components/ChangePasswordDialog/types.ts index fb74d8a3..bbc5f363 100644 --- a/login-workflow/src/components/ChangePasswordDialog/types.ts +++ b/login-workflow/src/components/ChangePasswordDialog/types.ts @@ -3,11 +3,23 @@ import { SuccessScreenProps } from '../../screens'; import { BasicDialogProps } from '../Dialog'; import { SetPasswordProps } from '../SetPassword'; +/** + * Props of ChangePasswordDialogSlots + */ export type ChangePasswordDialogSlots = { + /** + * used to define a function that renders success screen + */ SuccessScreen?: (props?: SuccessScreenProps) => JSX.Element; }; +/** + * Props of ChangePasswordDialogSlotsProps + */ export type ChangePasswordDialogSlotsProps = { + /** + * The props that will be passed to the success screen + */ SuccessScreen?: SuccessScreenProps; }; diff --git a/login-workflow/src/components/WorkflowCard/ErrorState.tsx b/login-workflow/src/components/WorkflowCard/ErrorState.tsx index ce2fee38..5b44b87a 100644 --- a/login-workflow/src/components/WorkflowCard/ErrorState.tsx +++ b/login-workflow/src/components/WorkflowCard/ErrorState.tsx @@ -2,6 +2,14 @@ import React from 'react'; import { Typography } from '@mui/material'; import { ErrorStateProps } from './WorkflowCard.types'; +/** + * Component renders a screen with ErrorState to display error message for support with the application. + * + * @param {ErrorStateProps} props - props of ErrorStateProps component + * + * @category Component + */ + export const ErrorState: React.FC = (props) => { const { message, sx, ...otherTypographyProps } = props; diff --git a/login-workflow/src/components/WorkflowCard/Utility.ts b/login-workflow/src/components/WorkflowCard/Utility.ts index d8953da3..240f5fa6 100644 --- a/login-workflow/src/components/WorkflowCard/Utility.ts +++ b/login-workflow/src/components/WorkflowCard/Utility.ts @@ -1,7 +1,14 @@ import generateUtilityClass from '@mui/material/generateUtilityClass'; export type WorkflowCardClasses = { + /** + * The class name for the root element. + */ root?: string; + + /** + * The class name for the card element. + */ card?: string; }; @@ -13,9 +20,24 @@ export function getWorkflowCardUtilityClass(slot: string): string { // For WorkflowCardActions component export type workflowCardActionsClasses = { + /** + * The class name for the root element. + */ root?: string; + + /** + * The class name for the next button element. + */ nextButton?: string; + + /** + * The class name for the previous button element. + */ previousButton?: string; + + /** + * The class name for the stepper element. + */ stepper?: string; }; diff --git a/login-workflow/src/contexts/AuthContext/context.ts b/login-workflow/src/contexts/AuthContext/context.ts index 3e15e1cd..0c830fad 100644 --- a/login-workflow/src/contexts/AuthContext/context.ts +++ b/login-workflow/src/contexts/AuthContext/context.ts @@ -5,4 +5,7 @@ import { createContext } from 'react'; import { AuthContextProviderProps } from './types'; +/** + * Auth Context is used to access context in the authentication workflow + */ export const AuthContext = createContext(null); diff --git a/login-workflow/src/contexts/ErrorContext/context.ts b/login-workflow/src/contexts/ErrorContext/context.ts index c94e2cf3..ba21b762 100644 --- a/login-workflow/src/contexts/ErrorContext/context.ts +++ b/login-workflow/src/contexts/ErrorContext/context.ts @@ -5,4 +5,7 @@ import { createContext } from 'react'; import { ErrorContextProviderProps } from './types'; +/** + * An object that is used for error handling within the application + */ export const ErrorContext = createContext(null); diff --git a/login-workflow/src/contexts/ErrorContext/types.ts b/login-workflow/src/contexts/ErrorContext/types.ts index 5369dbd9..e27b5d65 100644 --- a/login-workflow/src/contexts/ErrorContext/types.ts +++ b/login-workflow/src/contexts/ErrorContext/types.ts @@ -5,4 +5,7 @@ import { ErrorManagerProps } from '../../components/Error/types'; +/** + * An object that is used as error handling context within the workflow. + */ export type ErrorContextProviderProps = Omit; diff --git a/login-workflow/src/contexts/RegistrationWorkflowContext/context.ts b/login-workflow/src/contexts/RegistrationWorkflowContext/context.ts index 5ec2f5a4..af9bbd59 100644 --- a/login-workflow/src/contexts/RegistrationWorkflowContext/context.ts +++ b/login-workflow/src/contexts/RegistrationWorkflowContext/context.ts @@ -6,4 +6,7 @@ import { createContext } from 'react'; import { RegistrationWorkflowContextProps } from './types'; +/** + * Registration Workflow Context is used to access context in the Registration Workflow component + */ export const RegistrationWorkflowContext = createContext(null);