Skip to main content

<GoogleOneTap /> component

Important

To use Google One Tap with Clerk, you must enable Google as a social connection in the Clerk Dashboard and make sure to use custom credentials.

The <GoogleOneTap /> component renders the Google One Tap UI so that users can use a single button to sign-up or sign-in to your Clerk application with their Google accounts.

By default, this component will redirect users back to the page where the authentication flow started. However, you can override this with force redirect URL props or force redirect URL environment variables.

Tip

<GoogleOneTap> does not render if the user is already signed into your Clerk application, so there's no need to manually check if a user is signed in yourself before rendering it.

Example

The following example includes a basic implementation of the <GoogleOneTap /> component. You can use this as a starting point for your own implementation.

app/routes/sign-in.tsx
import { GoogleOneTap } from '@clerk/react-router'

export default function Page() {
  return <GoogleOneTap />
}

Methods

The methods in this section are available on instances of the Clerk class and are used to render and control the <GoogleOneTap /> component.

openGoogleOneTap()

Opens the <GoogleOneTap /> component.

function openGoogleOneTap(props?: GoogleOneTapProps): void

closeGoogleOneTap()

Closes the <GoogleOneTap /> component.

function closeGoogleOneTap(): void

authenticateWithGoogleOneTap()

Authenticates user using a Google token generated from Google identity services.

function authenticateWithGoogleOneTap(params: AuthenticateWithGoogleOneTapParams): Promise<SignInResource | SignUpResource>

AuthenticateWithGoogleOneTapParams

  • Name
    legalAccepted?
    Type
    boolean
    Description

    A boolean indicating whether the user has agreed to the legal compliance documents.

  • Name
    token
    Type
    string
    Description

    The Google credential token from the Google Identity Services response.

handleGoogleOneTapCallback()

Completes a Google One Tap redirection flow started by authenticateWithGoogleOneTap(). Also calls Clerk.setActive() and performs a custom navigation if given a custom navigation function.

function handleGoogleOneTapCallback(
  signInOrUp: SignInResource | SignUpResource,
  params: HandleOAuthCallbackParams,
  customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown>

handleGoogleOneTapCallback() params

  • Name
    signInOrUp
    Type
    SignInResource | SignUpResource
    Description

    The SignIn or SignUp object returned from authenticateWithGoogleOneTap().

  • Name
    params
    Type
    HandleOAuthCallbackParams
    Description

    An object containing redirect URLs. Useful if you want to set URLs specific to Google One Tap. Otherwise, consider using environment variables to set redirect URLs.

  • Name
    customNavigate?
    Type
    (to: string) => Promise<unknown>
    Description

    A function that overrides Clerk's default navigation behavior, allowing custom handling of navigation during sign-up and sign-in flows.

Properties

  • Name
    cancelOnTapOutside?
    Type
    boolean
    Description

    If true, the One Tap prompt closes automatically if the user clicks outside of the prompt. Defaults to true.

  • Name
    itpSupport?
    Type
    boolean
    Description

    If true, enables the ITP-specific UX when One Tap is rendered on ITP browsers such as Chrome on iOS, Safari, and FireFox. Defaults to true.

  • Name
    fedCmSupport?
    Type
    boolean
    Description

    If true, enables Google One Tap to use the FedCM API to sign users in. See Google's docs on best practices when disabling FedCM support. Defaults to true

  • Name
    signInForceRedirectUrl?
    Type
    string
    Description

    Useful if you want to redirect to a path specific to Google One Tap users. If provided, this URL will always be redirected to after the user signs in, overriding any <ClerkProvider> redirect URL props or redirect URL environment variables.

  • Name
    signUpForceRedirectUrl?
    Type
    string
    Description

    Useful if you want to redirect to a path specific to Google One Tap users. If provided, this URL will always be redirected to after the user signs up, overriding any <ClerkProvider> redirect URL props or redirect URL environment variables.

Limitations

  • If your application will use the Google API on behalf of your users, the <GoogleOneTap> component is not recommended, as Google does not provide Clerk with an access or refresh token that you can use.
  • Users with the 1Password browser extension may not be able to render the Google One Tap UI. They must disable this extension.
  • When testing in development, if you select the X button to close the Google One Tap UI, you may encounter a cooldown that prevents you from rendering it again for a period of time. To bypass the cooldown, remove the g_state cookie.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub