@brightlayer-ui/react-auth-workflow/screens/VerifyCodeScreen/types.d.ts

Re-usable workflow components for Authentication and Registration within Eaton applications.

import { TextFieldProps } from '@mui/material';
import { ErrorManagerProps } from '../../components/Error/types.js';
import { WorkflowCardProps } from '../../components/WorkflowCard/WorkflowCard.types.js';
export type VerifyCodeScreenProps = WorkflowCardProps & {
    /**
     * The function that validates the code text field
     * @param {string} code - validates code input length
     * @returns boolean | string
     */
    codeValidator?: (code: string) => boolean | string;
    /**
     * The function that is called when the resend link/button is clicked
     * @returns void
     */
    onResend?: () => void;
    /**
     * The text to display ahead of the resend link/button
     */
    resendInstructions?: string;
    /**
     * The text to display for the resend link/button
     */
    resendLabel?: string;
    /**
     * The initial value for the code text field
     */
    initialValue?: string;
    /**
     * The label for the code text field
     */
    verifyCodeInputLabel?: string;
    /**
     * The configuration for customizing how errors are displayed
     */
    errorDisplayConfig?: ErrorManagerProps;
    /**
     * The props to pass to the verify code field.
     * See [MUI's TextFieldProps API](https://mui.com/material-ui/api/text-field/) for more details.
     */
    verifyCodeTextFieldProps?: TextFieldProps;
};