vue3-google-oauth2

Handling Google sign-in and sign-out for Vue3 applications.
141,765 56
vue vue3 google login authentication oauth2 gapi signin signout logout
Install
npm install vue3-google-oauth2
Latest Version:1.0.7
License:MIT
Last Updated:Feb 17, 2023
Links: GitHub  ·  npm
Maintainer: guruahn

DEPRECATED - no longer actively maintained

You can use this plugin vue3-google-login instead to have support for the new Google Identity Services JavaScript library.

vue3-google-oauth2

Handling Google sign-in and sign-out for Vue3 applications.

Please refer to here for Vue2 applications.

npm bundle size GitHub vue3-google-oauth2

Front-end Demo

Installation

Installation with npm

npm install vue3-google-oauth2

Installation with yarn

yarn add vue3-google-oauth2

Initialization

import { createApp } from 'vue'
import App from './App.vue'
import GAuth from 'vue3-google-oauth2'
const app = createApp(App)

const gAuthOptions = { clientId: 'YOUR_CLIENT_ID', scope: 'email', prompt: 'consent', fetch_basic_profile: false }
app.use(GAuth, gAuthOptions)

Options

Property Type Required Description
clientId String Required. The app's client ID, found and created in the Google Developers Console.
scope String Optional. Default value is profile email. Full list of scopes.
prompt String Optional. This value using for authCode. The possible values are select_account or consent. Default value is select_account. To get refresh token from auth code, use consent.
fetch_basic_profile Boolean Optional. If set to true, email profile openid will be automatically added as scope. Default value is true.

Methods

Property Description Type
instance return of gapi.auth2.getAuthInstance() Object
signIn function for sign-in Function
getAuthCode function for getting authCode Function
signOut function for sign-out Function

Reactivity

We support reactivity by Provide/Injection. Refer to sample project.

Property Description Type
Vue3GoogleOauth.isInit it will return reactivity object value({isInit, isAuthorized}) Object
Vue3GoogleOauth.isAuthorized it will return reactivity object value({isInit, isAuthorized}) Object

Usages

Refer to sample project.

Extra - Directly get access_token and refresh_token on Server-side

To get access_token and refresh_token in server side, the data for redirect_uri should be postmessage. postmessage is magic value for redirect_uri to get credentials without actual redirect uri.

Curl

curl -d "client_id=YOUR_CLIENT_ID&\
  client_secret=YOUR_CLIENT_SECRET&\
  redirect_uri=postmessage&\
  grant_type=authorization_code&\
  code=YOUR_AUTH_CODE" https://accounts.google.com/o/oauth2/token

Sample Code

Additional Help

FAQ

The failure of initialization happens

You can check the brower console to check errors which occur during initialization. The most of errors are from inproper setting of google oauth2 credentials setting in Google Developer Console. After changing the settings, you have to do hard refresh to clear your caches.

Related Packages

vue-google-oauth2

Handling Google Auth2 sign-in and sign-out

175,570 180
authentication gapi google login logout oauth2 signin signout vue
vue-google-auth

Handling Google sign-in and sign-out

3,869 47
authentication gapi google login logout signin signout vue
vue-google-auth2

Handling Google sign-in and sign-out

2,529 47
authentication gapi google login logout signin signout vue
vue-google-api

This vue 2 plugin is a wrapper for the script needed to do client side operation...

10,121 33
authentication google oauth2 api
vue-oauth2-google

Using the Google Identity Services authorization code model a popup dialog for u...

1,005
authentication google oauth2 vue google identity services

Version History

Version Released License
1.0.7 MIT
1.0.6 MIT
1.0.4 MIT
1.0.3 MIT
1.0.2 MIT
Pre-releases (1)
Version Released License
0.0.1-security