Skip to main content
Docs

useSignUp()

The useSignUp() hook provides access to the SignUpFutureJavaScript Icon 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 custom sign-up flow.

Returns

  • Name
    signUp
    Type
    SignUpFutureJavaScript Icon
    Description

    The current active SignUpFuture instance, for use in custom flows.

    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.

  • Name
    errors
    Type
    ErrorsJavaScript Icon
    Description

    The errors that occurred during the last API request.

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

    The fetch status of the underlying SignUpFuture resource.

Examples

For example usage of the useSignUp() hook, see the Build your own UI guide.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on