Skip to main content
Docs

useSignUp()

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

Returns

  • Name
    errors
    Type
    SignUpErrors
    Description

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

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

    The fetch status of the underlying SignUpFuture resource.

  • Name
    signUp
    Type
    SignUpFutureResource
    Description

    The underlying SignUpFuture resource.

Important

The SignUpFuture instance referenced by signUp does not have a stable identity, and will change as the sign-up 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 useSignUp() hook, see the Build your own UI guides.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub