React OAuth2 | Google

Google OAuth2 using the new Google Identity Services SDK for React @moeindana/google-oauth?

Install

$ npm install @moeindana/google-oauth@latest

# or

$ yarn add @moeindana/google-oauth@latest

Seamless sign-in and sign-up flows

Sign In With Google

Add a personalized and customizable sign-up or sign-in button to your website.

One-tap sign-up

Sign up new users with just one tap, without interrupting them with a sign-up screen. Users get a secure, token-based, passwordless account on your site, protected by their Google Account.

Automatic sign-in

Sign users in automatically when they return to your site on any device or browser, even after their session expires.

User authorization for Google APIs (with custom button)

OAuth 2.0 implicit and authorization code flows for web apps

The Google Identity Services JavaScript library helps you to quickly and safely obtain access tokens necessary to call Google APIs. Your web application, complete either the OAuth 2.0 implicit flow, or to initiate the authorization code flow which then finishes on your backend platform.

How to use

1. Get your Google API client ID

Key Point: Add both http://localhost and http://localhost:<port_number> to the Authorized JavaScript origins box for local tests or development.

2. Configure your OAuth Consent Screen

3. Wrap your application with GoogleOAuthProvider

import { GoogleOAuthProvider } from '@moeindana/google-oauth';

<GoogleOAuthProvider clientId="<your_client_id>">...</GoogleOAuthProvider>;

Sign In With Google

import { GoogleLogin } from '@moeindana/google-oauth';

<GoogleLogin
  onSuccess={response => {
    console.log(response);
  }}
  onError={() => {
    console.log('Login Failed');
  }}
/>;

One-tap

import { useGoogleOneTapLogin } from '@moeindana/google-oauth';

useGoogleOneTapLogin({
    onSuccess: response => {
        console.log(response);
    },
    onError={() => {
        console.log('Login Failed')
    }}
});

or

import { GoogleLogin } from '@moeindana/google-oauth';

<GoogleLogin
  onSuccess={response => {
    console.log(response);
  }}
  onError={() => {
    console.log('Login Failed');
  }}
  useOneTap
/>;

If you are using one tap login, when logging user out consider this issue may happen, to prevent it call googleLogout when logging user out from your application.

import { googleLogout } from '@moeindana/google-oauth';

googleLogout();

Automatic sign-in

auto_select prop true

<GoogleLogin
    ...
    auto_select
/>

useGoogleOneTapLogin({
    ...
    auto_select
});

Custom login button (implicit & authorization code flow)

Implicit flow

import { useGoogleLogin } from '@moeindana/google-oauth';

const login = useGoogleLogin({
  onSuccess: tokenResponse => console.log(tokenResponse),
});

<MyCustomButton onClick={() => login()}>
  Sign in with Google ?{' '}
</MyCustomButton>;

Authorization code flow

Requires backend to exchange code with access and refresh token.

import { useGoogleLogin } from '@moeindana/google-oauth';

const login = useGoogleLogin({
  onSuccess: codeResponse => console.log(codeResponse),
  flow: 'auth-code',
});

<MyCustomButton onClick={() => login()}>
  Sign in with Google ?{' '}
</MyCustomButton>;

Checks if the user granted all the specified scope or scopes

import { hasGrantedAllScopesGoogle } from '@moeindana/google-oauth';

const hasAccess = hasGrantedAllScopesGoogle(
  tokenResponse,
  'google-scope-1',
  'google-scope-2',
);

Checks if the user granted any of the specified scope or scopes

import { hasGrantedAnyScopeGoogle } from '@moeindana/google-oauth';

const hasAccess = hasGrantedAnyScopeGoogle(
  tokenResponse,
  'google-scope-1',
  'google-scope-2',
);

API

GoogleOAuthProvider

GoogleLogin

useGoogleLogin (Both implicit & authorization code flow)

useGoogleLogin (Extra implicit flow props)

useGoogleLogin (Extra authorization code flow props)

useGoogleOneTapLogin

GitHub

View Github