1.1.8 • Published 7 years ago

@vroomlabs/react-gauth-button v1.1.8

Weekly downloads
-
License
ISC
Repository
-
Last release
7 years ago

Vroom Auth Login w/Google

Install

npm install @vroomlabs/react-gauth-button

How to use

import React from 'react';
import ReactDom from 'react-dom';
import VroomAuthLogin from '@vroomlabs/react-gauth-button';  

const authResponse = (response) {
    console.log(response)
}

ReactDom.render(
    <VroomAuthLogin 
        clientId="someid.apps.googleusercontent.com"
        buttonText="Sign In"
        onSuccess={authResponse}
        onFailure={authResponse}
    />,
    document.getElementById('vroom-auth')
);

Component can accept child components (e.g., icons)

onSuccess callback

If offlineMode is false, callback will return the GoogleUser object.

If offlineMode is true, callback will return the offline GoogleAuth Code for use on the server.

Hosted Domain is defaulted to vroom.com, make sure to validate the id_token (a JWT) returned by Google in your service: 1. The authResponse(response){...} callback function will return a JWT as response.hg.id_token 2. Send the JWT to the backend service (suggest using Auth header) 3. Recommendation: Backend service should verify the id_token by using a JWT library, jsonwebtoken. Use Google's public key to verify the token's signature 4. The returned decoded token should have an hd key value equal to the hosted domain specified.
hd = hosted domain

Args

argtypedefaultnote
clientidstringREQUIRED - none
hostedDomainstringvroom.com
scopestringnoneGoogle scopes can be found here
offlineModebooleanfalse
onSuccessfunctionREQUIRED - none
onFailurefunctionREQUIRED - none
onRequestfunctionnone
buttonTextstringSign In with Google
classNamestringnone
styleobjectnone
disabledStyleobjectnone
loginHintstringnone
promptstringnone
tagstringbuttonSet element tag (e.g., button, a, div, span)
authLoadbooleanfalse
fetchBasicProfilebooleantrue
disabledbooleanfalse
uiModestringpopupAlternative is uiMode=redirect after login. redirectUri needed if set
redirectUristringnoneMust be set if uiMode=redirect
isSignedInbooleannoneWill return GoogleUser object, if user has granted permission for your app

onSuccess callback - Auth Code

property namevaluedefinition
codeobjectoffline token

onSuccess callback - Token (Default)

Provides GAuth User Object with access to GoogleUser methods.
Returned values
| property name | value | definition | |:-------------:|:-------:|:-------------:| | googleId | string | GAuth User ID | | tokenId | string | Token ID | | accessToken | string | Access Token | | tokenObject | object | Token object | | profileObject | object | User Profile object |

onFailure callback

property namevaluedefinition
errorstringerror code
detailsstringerror message

Issues / Feedback

Please report any issues and suggest feedback through the repo! I hope you find the VroomAuth component useful and would be happy to give guidance on getting you going!

Happy Coding!

Puches

Created by

John Rodkey
Copyright © 2017 Vroom, Inc.
All Rights Reserved

1.1.8

7 years ago

1.1.7

7 years ago

1.1.6

7 years ago

1.1.5

7 years ago

1.1.4

7 years ago

1.1.3

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.2

7 years ago

1.0.1

7 years ago

1.0.0

7 years ago