Function useLogin

  • Returns a stateful function to initiate the unologin login flow.

    The login function returns a Promise.

    The Promise will resolve after successful login.

    The Promise will reject otherwise.

    Example

    function LoginButtonExample()
    {
    const login = useLogin();

    // login.loading is true once the login is initiated.
    // It is reset to false after the user information is available.
    console.log(login.loading)

    // login.open is true for as long as the login window is open.
    console.log(login.open)

    return <button
    disabled={login.loading}
    onClick={() => login({ userClass: 'users_default })}
    >
    log in
    </button>;
    }

    Returns

    Asynchronous function to initiate login flow.

    Type Parameters

    • DefaultOptions extends Partial<LoginOptions> = {}

    • LoginOptionsType = Partial<LoginOptions> & Omit<LoginOptions, keyof DefaultOptions>

    Parameters

    • Optional defaultOptions: DefaultOptions

      default values for options passed to the returned login() function.

    Returns CallbackWithState<CallbackWithState<((...args: DefaultOptions extends LoginOptions ? [] | [LoginOptionsType] : [LoginOptionsType]) => Promise<void>), {
        loading: boolean;
    }>, {
        open: boolean;
    }>

Generated using TypeDoc