npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nightowl-developers/use-google-auth

v0.0.1

Published

A single React Hook that loads the google api script in the head of your application and provides login and logout with Google functionality.

Downloads

5

Readme

Use-Google-Auth

Pipeline

A single React Hook that loads the google api script in the head of your application and provides login and logout with Google functionality.

Installation

npm install @nightowl-developers/use-google-auth

or

yarn add @nightowl-developers/use-google-auth

Usage

Usage is pretty straight-forward. The hook returns two functions that can be attached to a button element.

import * as React from 'react'

import useGoogleAuth from '@nightowl-developers/use-google-auth'

const MyComponent = () => {
  const [isLoggedIn, setIsLoggedIn] = React.useState(false)
  
  const {
    signIn,
    signOut,
  } = useGoogleAuth({
    clientId: 'your-google-client-id',
    onLoginChange: (loggedIn) => {
      setIsLoggedIn(loggedIn)
    },
    onLoginSuccess: (response) => {
      setIsLoggedIn(true)
      console.log('logged in success', response)
    },
    onLoginFailure: (error) => {
      setIsLoggedIn(false)
      console.log('logged in failure', error)
    },
  })
  
  return <>
    {isLoggedIn && <button onClick={signIn}>Sign In</button>}
    
    {!isLoggedIn && <button onClick={signOut}>Sign Out</button>}
  </>
}

Hook API

The useGoogleAuth hook takes an object with the following properties.

| Property | Default Value | Values | Description | |----------|---------------|--------|-------------| | clientId ||| The Google Client Id from your Google Developer Console. | | cookiePolicy | 'single_host_origin'| 'single_host_origin', 'none', string | | | hostedDomains ||| The G Suite domain in which users must belong to sign in. | | fetchBasicProfile ||| Adds 'profile email and openid' to scopes. | | onLoginChange ||| Callback function when auth changes without interaction. | | onLoginSuccess ||| Callback function when a user authenticates successfully. | | onLoginFailure ||| Callback function when a user fails to authenticate. | | onLogoutFailure ||| Callback function when a user logs out successfully. | | onLogoutSuccess ||| Callback function when a user fails to log out. | | prompt | 'select_account'| 'consent', 'select_account', 'none' | The consent flow mode (consent, select_account, or none). | | redirectUrl ||| The uri to redirect to when uxMode is 'redirect'. | | scope | ['profile']|| An arry of permission scopes. | | src | 'https://apis.google.com/js/platform.js || The URL to the Google API javascript script. | | stayLoggedIn | false | true, false | When true, the user will stay logged in between visites to your site. | | uxMode | 'popup'| 'popup', 'redirect'| Determines if the user will be redirected away from the site or if a prompt will be displayed. |

important: The only required property is clientId.

Callback Signatures

Below are all of the Typescript callback signature definitions.

onLoadFailure

  onLoadFailure: (error: any) => void

onLoginChange

(loggedIn: boolean) => void

onLoginFailure

(error: GoogleFailureObject) => void

onLoginSuccess

(response: GoogleSuccessObject) => void

onLogoutFailure

(error: GoogleFailureObject) => void

onLogoutSuccess

() => void

Google Object Definitions

GoogleSuccessObject

GoogleSuccessObject {

}

GoogleFailureObject

GoogleFailureObject {

}

Credit to Original Author

This package is a moderately refactored version of React Google Login. Below are the changes that have been made to fit my own needs.

  • code simplified to a single React Hook
  • improved Hook prop names to better describe their use-case
  • appens the google api script to the element
  • added onLoginChange callback prop to listen to revoked permissions or expired tokens
  • added onLogoutSuccess callback prop to execute code when a user successfully logs out