diff --git a/docs/references/react/use-auth.mdx b/docs/references/react/use-auth.mdx index 9cff57447a..30ec01f709 100644 --- a/docs/references/react/use-auth.mdx +++ b/docs/references/react/use-auth.mdx @@ -3,7 +3,7 @@ title: '`useAuth()`' description: Access and manage authentication state in your React application with Clerk's useAuth() hook. --- -The `useAuth()` hook provides access to the current authentication state and methods to manage the active session in your React application. +The `useAuth()` hook provides access to the current user's authentication state and methods to manage the active session. ## Returns @@ -60,7 +60,7 @@ The `useAuth()` hook provides access to the current authentication state and met - `signOut()` - `(options?: SignOutOptions) => Promise` - ## A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](/docs/references/javascript/clerk/clerk#sign-out). + A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](/docs/references/javascript/clerk/clerk#sign-out). - `getToken()` - `(options?: GetTokenOptions) => Promise` diff --git a/docs/references/react/use-organization.mdx b/docs/references/react/use-organization.mdx index 085d17d04c..a6ea31e0da 100644 --- a/docs/references/react/use-organization.mdx +++ b/docs/references/react/use-organization.mdx @@ -11,28 +11,28 @@ The `useOrganization()` hook retrieves attributes of the currently active organi - `invitations` - - `true | { status?: OrganizationInvitationStatus } & SharedProperties` + - `true | { status?: OrganizationInvitationStatus } & { SharedProperties }` If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `status` property of type [`OrganizationInvitationStatus`](#organization-invitation-status) and any of the properties described in [Shared properties](#shared-properties). --- - `membershipRequests` - - `true | { status?: OrganizationInvitationStatus } & SharedProperties` + - `true | { status?: OrganizationInvitationStatus } & { SharedProperties }` If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `status` property of type [`OrganizationInvitationStatus`](#organization-invitation-status) and any of the properties described in [Shared properties](#shared-properties). --- - `memberships` - - `true | { role?: OrganizationCustomRoleKey[] } & SharedProperties` + - `true | { role?: OrganizationCustomRoleKey[] } & { SharedProperties }` If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `role` property of type [`OrganizationCustomRoleKey[]`](#organization-custome-role-key) and any of the properties described in [Shared properties](#shared-properties). --- - `domains` - - `true | { enrollmentMode?: OrganizationEnrollmentMode } & SharedProperties` + - `true | { enrollmentMode?: OrganizationEnrollmentMode } & { SharedProperties }` If set to `true`, all default properties will be used. Otherwise, accepts an object with an optional `enrollmentMode` property of type [`OrganizationEnrollmentMode`](#organization-enrollment-mode) and any of the properties described in [Shared properties](#shared-properties). diff --git a/docs/references/react/use-sign-in.mdx b/docs/references/react/use-sign-in.mdx index c69272be10..7fef2172d7 100644 --- a/docs/references/react/use-sign-in.mdx +++ b/docs/references/react/use-sign-in.mdx @@ -5,7 +5,7 @@ description: Access and manage the current user's sign-in state in your React ap The `useSignIn()` composable provides access to the [`SignIn`](/docs/references/javascript/sign-in/sign-in) 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 [custom sign-in flow](/docs/custom-flows/overview#sign-in-flow). -## Reacteturns +## Returns - `isLoaded` @@ -101,7 +101,7 @@ The `status` property of the `SignIn` object can be one of the following values: - `needs_identifier` - `string` - The user's identifier (e.g., email address, phone number, username) hasn't been provided. + The user's [identifier](/docs/authentication/configuration/sign-up-sign-in-options#identifiers) (e.g., email address, phone number, username) is missing. --- diff --git a/docs/references/react/use-sign-up.mdx b/docs/references/react/use-sign-up.mdx index 2790df8873..9048d6b07d 100644 --- a/docs/references/react/use-sign-up.mdx +++ b/docs/references/react/use-sign-up.mdx @@ -3,7 +3,7 @@ title: '`useSignUp()`' description: Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook. --- -The `useSignUp()` composable provides access to the [`SignUp`](/docs/references/javascript/sign-up/sign-up) 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](/docs/custom-flows/overview#sign-up-flow). +The `useSignUp()` hook provides access to the [`SignUp`](/docs/references/javascript/sign-up/sign-up) 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](/docs/custom-flows/overview#sign-up-flow). ## Returns diff --git a/docs/references/react/use-user.mdx b/docs/references/react/use-user.mdx index 843b69a67e..c189382d68 100644 --- a/docs/references/react/use-user.mdx +++ b/docs/references/react/use-user.mdx @@ -23,7 +23,7 @@ The `useUser()` hook provides access to the current user's [`User`](/docs/refere --- - `user` - - [`User`](/docs/references/javascript/user/user) + - [User](/docs/references/javascript/user/user) \| null The `User` object for the current user. If the user isn't signed in, `user` will be `null`.