Interface SignUpOptions

interface SignUpOptions {
    services: {
        authApi: Pick<AuthApi, "login" | "getOAuthGoogleLoginUrl">;
        userApi: Pick<UserApi<unknown>, "createUser" | "getUser" | "sendVerificationEmail">;
    };
    settings: {
        alreadyVerifiedRoute: string;
        homeRoute: string;
        oAuthConfig?: {
            google?: false | {
                redirectRoute: string;
            };
        };
        passwordValidateStrategy: PasswordValidateStrategy;
        privacyPolicyUrl?: string;
        screenMode: "desktop" | "mobile";
        userAgreementUrl?: string;
    };
}

Properties

services settings

Properties

services

services: {
    authApi: Pick<AuthApi, "login" | "getOAuthGoogleLoginUrl">;
    userApi: Pick<UserApi<unknown>, "createUser" | "getUser" | "sendVerificationEmail">;
}

Type declaration

  • authApi: Pick<AuthApi, "login" | "getOAuthGoogleLoginUrl">

    Auth API

  • userApi: Pick<UserApi<unknown>, "createUser" | "getUser" | "sendVerificationEmail">

    User API

settings

settings: {
    alreadyVerifiedRoute: string;
    homeRoute: string;
    oAuthConfig?: {
        google?: false | {
            redirectRoute: string;
        };
    };
    passwordValidateStrategy: PasswordValidateStrategy;
    privacyPolicyUrl?: string;
    screenMode: "desktop" | "mobile";
    userAgreementUrl?: string;
}

Type declaration

  • alreadyVerifiedRoute: string

    Route to redirect to if already logged in and verified email

  • homeRoute: string

    Route to link to when clicking the 'back' button at the bottom of the page

  • Optional oAuthConfig?: {
        google?: false | {
            redirectRoute: string;
        };
    }

    Configuration for oauth behavior. If not provided, no oauth buttons are shown

    • Optional google?: false | {
          redirectRoute: string;
      }
  • passwordValidateStrategy: PasswordValidateStrategy

    Password validation strategy

  • Optional privacyPolicyUrl?: string

    External url for privacy policy. If not provided, do not include checkbox

  • screenMode: "desktop" | "mobile"

    Screen size to show for this block

  • Optional userAgreementUrl?: string

    External url for privacy policy. If not provided, do not include checkbox

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc