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.

  • Name
    errors
    Type
    Errors
    Description

    The errors that occurred during the last API request.

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

    The fetch status of the underlying SignUpFuture resource.

Feedback

What did you think of this content?

Last updated on