Skip to main content
Docs

useSignIn()

The useSignIn() hook provides access to the SignInFuture object, which allows you to check the current state of a sign-in attempt and manage the sign-in flow. You can use this to create a .

Returns

  • Name
    errors
    Type
    SignInErrors
    Description

    The errors that occurred during the last fetch of the underlying SignInFuture resource.

  • Name
    fetchStatus
    Type
    "idle" | "fetching"
    Description

    The fetch status of the underlying SignInFuture resource.

  • Name
    signIn
    Type
    SignInFutureResource
    Description

    An instance representing the currently active SignInFuture, with new APIs designed specifically for custom flows.

Important

The SignInFuture instance referenced by signIn does not have a stable identity, and will change as the sign-in flow progresses. Make sure you provide it in dependency arrays when using hooks such as useEffect, useCallback, or useMemo.

Examples

For example usage of the useSignIn() hook, see the Build your own UI guides.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub