@brightlayer-ui/react-native-auth-workflow/components/RegistrationWorkflow/types.d.ts

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

/// <reference types="react" />
import { ErrorManagerProps } from '../Error/index.js';
/**
 * Props for RegistrationWorkflow component which includes screens related to user sign-up / registration
 */
export type SharedRegistrationWorkflowProps = {
    /**
     * The initial screen index to start the registration workflow from
     * @default 0
     */
    initialScreenIndex?: number;
    /**
     * The success screen to display upon successful registration
     */
    successScreen?: React.JSX.Element;
    /**
     * Component to display for the success screen if the account already exists.
     */
    existingAccountSuccessScreen?: React.JSX.Element;
    /**
     * The configuration for customizing how errors are displayed
     */
    errorDisplayConfig?: ErrorManagerProps;
    /**
     * If true, the EULA content is HTML and should be rendered as such.
     */
    eulaIsHtml?: boolean;
};
export type SelfRegistrationWorkflowProps = SharedRegistrationWorkflowProps & {
    /**
     * Boolean when true verifies validateUserRegistrationRequest for verifyCode
     */
    isInviteRegistration?: false;
};
export type InviteRegistrationWorkflowProps = SharedRegistrationWorkflowProps & {
    /**
     * Boolean when true verifies validateUserRegistrationRequest for verifyCode
     */
    isInviteRegistration: true;
    /**
     * Set initial values for VerifyCode and Create Account Screen
     */
    initialRegistrationParams: {
        /**
         * code to populate in VerifyCode screen
         */
        code: string;
        /**
         * email address to populate in Create Account Screen
         */
        email: string;
    };
};
export type RegistrationWorkflowProps = SelfRegistrationWorkflowProps | InviteRegistrationWorkflowProps;