Interface LoginOptions

interface LoginOptions {
    services: {
        authApi: Pick<AuthApi, "login" | "getOAuthGoogleLoginUrl">;
        userApi: Pick<UserApi<unknown>, "getUser" | "sendVerificationEmail">;
    };
    settings: {
        alreadyVerifiedRoute: string;
        oAuthConfig?: {
            google?: false | {
                redirectRoute: string;
            };
        };
        screenMode: "desktop" | "mobile";
        showSignupLink?: boolean;
    };
}

Properties

services settings

Properties

services

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

Type declaration

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

    Auth Api

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

    User Api

settings

settings: {
    alreadyVerifiedRoute: string;
    oAuthConfig?: {
        google?: false | {
            redirectRoute: string;
        };
    };
    screenMode: "desktop" | "mobile";
    showSignupLink?: boolean;
}

Type declaration

  • alreadyVerifiedRoute: string

    Route to redirect to if already logged in and verified

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

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

    • Optional google?: false | {
          redirectRoute: string;
      }
  • screenMode: "desktop" | "mobile"

    Screen size to show for this block

  • Optional showSignupLink?: boolean

    Enable signup link on login page

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc