ReactDOM.render(<GoogleLoginclientId="658977310896-knrl3gka66fldh83dao2rhgbblmd4un9.apps.googleusercontent.com"render={renderProps=>(<buttononClick={renderProps.onClick}disabled={renderProps.disabled}>This is my custom Google button</button>)}buttonText="Login"onSuccess={responseGoogle}onFailure={responseGoogle}cookiePolicy={'single_host_origin'}/>,document.getElementById('googleButton'));
Stay Logged in
isSignedIn={true} attribute will call onSuccess callback on load to keep the user signed in.
If responseType is not 'code', callback will return the GoogleAuth object.
If responseType is 'code', callback will return the authorization code that can
be used to retrieve a refresh token from the server.
If you use the hostedDomain param, make sure to validate the id_token (a JSON web token) returned by Google on your backend server:
In the responseGoogle(response) {...} callback function, you should get back a standard JWT located at response.tokenId or res.getAuthResponse().id_token
Send this token to your server (preferably as an Authorization header)
Have your server decode the id_token by using a common JWT library such as jwt-simple or by sending a GET request to https://www.googleapis.com/oauth2/v3/tokeninfo?id_token=YOUR_TOKEN_HERE
The returned decoded token should have an hd key equal to the hosted domain you'd like to restrict to.
Logout
Use GoogleLogout button to logout the user from google.
URL of the Javascript file normally hosted by Google
hostedDomain
string
-
The G Suite domain to which users must belong to sign in
scope
string
profile email
responseType
string
permission
Can be either space-delimited 'id_token', to retrieve an ID Token + 'permission' (or 'token'), to retrieve an Access Token, or 'code', to retrieve an Authorization Code.
accessType
string
online
Can be either 'online' or 'offline'. Use offline with responseType 'code' to retrieve an authorization code for fetching a refresh token
onSuccess
function
REQUIRED
onFailure
function
REQUIRED
onScriptLoadFailure
function
-
If defined, will be called when loading the 'google-login' script fails (otherwise onFailure will be called)
onRequest
function
-
onAutoLoadFinished
function
-
buttonText
string
Login with Google
className
string
-
style
object
-
disabledStyle
object
-
loginHint
string
-
prompt
string
-
Can be 'consent' to force google return refresh token.
If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. The default redirect_uri is the current URL stripped of query parameters and hash fragment.
isSignedIn
boolean
false
If true will return GoogleUser object on load, if user has given your app permission
render
function
-
Render prop to use a custom element, use renderProps.onClick
If using ux_mode='redirect', this parameter allows you to override the default redirect_uri that will be used at the end of the consent flow. The default redirect_uri is the current URL stripped of query parameters and hash fragment.
isSignedIn
boolean
false
If true will return GoogleUser object on load, if user has given your app permission
render
function
-
Render prop to use a custom element, use renderProps.onClick
You can also access the returned values via the following properties on the returned object.
property name
value
definition
googleId
string
Google user ID
tokenId
string
Token Id
accessToken
string
Access Token
tokenObj
object
Token details object
profileObj
object
Profile details object
onSuccess callback ( w/ offline true)
property name
value
definition
code
object
offline token
You can also pass child components such as icons into the button component.
<GoogleLoginclientId={'658977310896-knrl3gka66fldh83dao2rhgbblmd4un9.apps.googleusercontent.com'}onSuccess={responseGoogle}onFailure={responseGoogle}><FontAwesomename='google'/><span> Login with Google</span></GoogleLogin>
onFailure callback
onFailure callback is called when either initialization or a signin attempt fails.
property name
value
definition
error
string
Error code
details
string
Detailed error description
Common error codes include:
error code
description
idpiframe_initialization_failed
initialization of the Google Auth API failed (this will occur if a client doesn't have third party cookies enabled)
popup_closed_by_user
The user closed the popup before finishing the sign in flow.
access_denied
The user denied the permission to the scopes required
immediate_failed
No user could be automatically selected without prompting the consent flow.
More details can be found in the official Google docs:
请发表评论