diff --git a/docs/references/javascript/clerk/session-methods.mdx b/docs/references/javascript/clerk/session-methods.mdx index 4b3ab5b8ec..36f6a71893 100644 --- a/docs/references/javascript/clerk/session-methods.mdx +++ b/docs/references/javascript/clerk/session-methods.mdx @@ -33,7 +33,7 @@ function setActive({ session, organization, beforeEmit }: SetActiveParams): Prom - `beforeEmit?` - `(session?: Session | null) => void | Promise` - Callback run just before the active session and/or organization is set to the passed object. Can be used to hook up for pre-navigation actions. + Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions. ### Example diff --git a/docs/references/javascript/sign-in/sign-in.mdx b/docs/references/javascript/sign-in/sign-in.mdx index 9eac85f5f2..b567f92512 100644 --- a/docs/references/javascript/sign-in/sign-in.mdx +++ b/docs/references/javascript/sign-in/sign-in.mdx @@ -22,11 +22,11 @@ The following steps outline the sign-in process: The current status of the sign-in. `SignInStatus` supports the following values: - - `needs_identifier`: The authentication identifier hasn't been provided. - - `needs_first_factor`: First factor verification for the provided identifier needs to be prepared and verified. See [First Factor](/docs/references/javascript/sign-in/first-factor) for details. - - `needs_second_factor`: Second factor verification (2FA) for the provided identifier needs to be prepared and verified. See [Second Factor](/docs/references/javascript/sign-in/second-factor) for details. + - `complete`: The user is signed in and the custom flow can proceed to `setActive()` to create a session. + - `needs_identifier`: The user's identifier (e.g., email address, phone number, username) hasn't been provided. + - `needs_first_factor`: One of the following [first factor verification strategies](/docs/references/javascript/sign-in/first-factor) is missing: `email_link`, `email_code`, `phone_code`, `web3_metamask_signature`, `web3_coinbase_wallet_signature` or `oauth_provider`. + - `needs_second_factor`: One of the following [second factor verification strategies](/docs/references/javascript/sign-in/second-factor) is missing: `phone_code` or `totp`. - `needs_new_password`: The user needs to set a new password. - - `complete`: The sign-in is complete and the user is authenticated. --- diff --git a/docs/references/javascript/sign-up/sign-up.mdx b/docs/references/javascript/sign-up/sign-up.mdx index 94a3311c4d..abc34dbe54 100644 --- a/docs/references/javascript/sign-up/sign-up.mdx +++ b/docs/references/javascript/sign-up/sign-up.mdx @@ -27,9 +27,9 @@ The following steps outline the sign-up process: The status of the current sign-up. The following values are supported: - - `missing_requirements:` There are required fields that are either missing or they are unverified. - - `complete:` All the required fields have been supplied and verified, so the sign-up is complete and a new user and a session have been created. - - `abandoned:` The sign-up has been inactive for a long period of time, thus it's considered as abandoned and need to start over. + - `complete:` The user has been created and the custom flow can proceed to `setActive()` to create session. + - `missing_requirements:` A requirement is unverified or missing from the [**Email, Phone, Username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) settings. For example, in the Clerk Dashboard, the **Password** setting is required but a password wasn't provided in the custom flow. + - `abandoned:` The sign-up has been inactive for over 24 hours. --- diff --git a/docs/references/react/use-auth.mdx b/docs/references/react/use-auth.mdx index 755e0fb304..b9772b3fb6 100644 --- a/docs/references/react/use-auth.mdx +++ b/docs/references/react/use-auth.mdx @@ -1,5 +1,5 @@ --- -title: '`useAuth()`' +title: useAuth() description: Access and manage authentication state in your React application with Clerk's useAuth() hook. --- diff --git a/docs/references/react/use-clerk.mdx b/docs/references/react/use-clerk.mdx index d8c3fd21f1..b0aa193cbb 100644 --- a/docs/references/react/use-clerk.mdx +++ b/docs/references/react/use-clerk.mdx @@ -1,5 +1,5 @@ --- -title: '`useClerk()`' +title: useClerk() description: Access and manage the Clerk object in your React application with Clerk's useClerk() hook. --- diff --git a/docs/references/react/use-organization-list.mdx b/docs/references/react/use-organization-list.mdx index dd611b8f63..515449f18a 100644 --- a/docs/references/react/use-organization-list.mdx +++ b/docs/references/react/use-organization-list.mdx @@ -78,7 +78,7 @@ type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked' type OrganizationSuggestionStatus = 'pending' | 'accepted' ``` -## `useOrganizationList()` returns +## Returns - `isLoaded` @@ -158,7 +158,7 @@ type OrganizationSuggestionStatus = 'pending' | 'accepted' - `beforeEmit?` - `(session?: Session | null) => void | Promise` - Callback run just before the active session and/or organization is set to the passed object. Can be used to hook up for pre-navigation actions. + Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions. ### `PaginatedResources` diff --git a/docs/references/react/use-organization.mdx b/docs/references/react/use-organization.mdx index a6ea31e0da..a5868e5593 100644 --- a/docs/references/react/use-organization.mdx +++ b/docs/references/react/use-organization.mdx @@ -1,5 +1,5 @@ --- -title: '`useOrganization()`' +title: useOrganization() description: Access and manage the currently active organization in your React application with Clerk's useOrganization() hook. --- diff --git a/docs/references/react/use-reverification.mdx b/docs/references/react/use-reverification.mdx index 4361f3cd92..675ab5da9b 100644 --- a/docs/references/react/use-reverification.mdx +++ b/docs/references/react/use-reverification.mdx @@ -1,5 +1,5 @@ --- -title: '`useReverification()`' +title: useReverification() description: Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow. --- diff --git a/docs/references/react/use-session-list.mdx b/docs/references/react/use-session-list.mdx index 6a81373bab..10356e6943 100644 --- a/docs/references/react/use-session-list.mdx +++ b/docs/references/react/use-session-list.mdx @@ -1,5 +1,5 @@ --- -title: '`useSessionList()`' +title: useSessionList() description: Access and manage the current user's session list in your React application with Clerk's useSessionList() hook. --- @@ -48,7 +48,7 @@ The `useSessionList()` hook returns an array of [`Session`](/docs/references/jav - `beforeEmit?` - `(session?: Session | null) => void | Promise` - Callback run just before the active session and/or organization is set to the passed object. Can be used to hook up for pre-navigation actions. + Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions. ## How to use the `useSessionList()` hook diff --git a/docs/references/react/use-session.mdx b/docs/references/react/use-session.mdx index 92c0f26ade..12ff7cdb55 100644 --- a/docs/references/react/use-session.mdx +++ b/docs/references/react/use-session.mdx @@ -1,5 +1,5 @@ --- -title: '`useSession()`' +title: useSession() description: Access and manage the current user's session in your React application with Clerk's useSession() hook. --- diff --git a/docs/references/react/use-sign-in.mdx b/docs/references/react/use-sign-in.mdx index 13c7b55668..a6823b30d8 100644 --- a/docs/references/react/use-sign-in.mdx +++ b/docs/references/react/use-sign-in.mdx @@ -1,5 +1,5 @@ --- -title: '`useSignIn()`' +title: useSignIn() description: Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook. --- @@ -48,7 +48,7 @@ The `useSignIn()` hook provides access to the [`SignIn`](/docs/references/javasc - `beforeEmit?` - `(session?: Session | null) => void | Promise` - Callback run just before the active session and/or organization is set to the passed object. Can be used to hook up for pre-navigation actions. + Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions. ## How to use the `useSignIn()` hook @@ -72,45 +72,6 @@ export default function SignInPage() { } ``` -### `SignIn` status values - -The `status` property of the `SignIn` object can be one of the following values: - - - - `complete` - - `string` - - The user has been signed in and the custom flow can proceed to `setActive()` to create a session. - - --- - - - `needs_first_factor` - - `string` - - One of the following [first factor verification strategies](/docs/references/javascript/sign-in/first-factor) is missing: `email_link`, `email_code`, `phone_code`, `web3_metamask_signature`, `web3_coinbase_wallet_signature` or `oauth_provider`. - - --- - - - `needs_second_factor` - - `string` - - One of the following [second factor verification strategies](/docs/references/javascript/sign-in/second-factor) is missing: `phone_code` or `totp`. - - --- - - - `needs_identifier` - - `string` - - The user's [identifier](/docs/authentication/configuration/sign-up-sign-in-options#identifiers) (e.g., email address, phone number, username) is missing. - - --- - - - `needs_new_password` - - `string` - - The user needs to set a new password. - - ### Create a custom sign-in flow with `useSignIn()` The `useSignIn()` hook can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `useSignIn()` hook to create custom flows, see the [custom flow guides](/docs/custom-flows/overview). diff --git a/docs/references/react/use-sign-up.mdx b/docs/references/react/use-sign-up.mdx index 834054887d..5ce343d2f6 100644 --- a/docs/references/react/use-sign-up.mdx +++ b/docs/references/react/use-sign-up.mdx @@ -1,5 +1,5 @@ --- -title: '`useSignUp()`' +title: useSignUp() description: Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook. --- @@ -48,7 +48,7 @@ The `useSignUp()` hook provides access to the [`SignUp`](/docs/references/javasc - `beforeEmit?` - `(session?: Session | null) => void | Promise` - Callback run just before the active session and/or organization is set to the passed object. Can be used to hook up for pre-navigation actions. + Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions. ## How to use the `useSignUp()` hook @@ -72,31 +72,6 @@ export default function SignUpPage() { } ``` -### `SignUp` status values - -The `status` property of the `SignUp` object can be one of the following values: - - - - `complete` - - `string` - - The user has been created and the custom flow can proceed to `setActive()` to create a session. - - --- - - - `abandoned` - - `string` - - The sign-up attempt will be abandoned if it was started more than 24 hours previously. - - --- - - - `missing_requirements` - - `string` - - A requirement is missing from the [Email, Phone, Username](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) settings. For example, in the Clerk Dashboard, the **Password** setting is required but a password wasn't provided in the custom flow. - - ### Create a custom sign-up flow with `useSignUp()` The `useSignUp()` hook can also be used to build fully custom sign-up flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-up flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the `useSignUp()` hook to create custom flows, see the [custom flow guides](/docs/custom-flows/overview). diff --git a/docs/references/react/use-user.mdx b/docs/references/react/use-user.mdx index 4c3b635bf0..2a313d5c51 100644 --- a/docs/references/react/use-user.mdx +++ b/docs/references/react/use-user.mdx @@ -1,5 +1,5 @@ --- -title: '`useUser()`' +title: useUser() description: Access and manage the current user's data in your React application with Clerk's useUser() hook. ---