
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@iruthayaj/capacitor-google-auth
Advanced tools
Capacitor plugin for Google Auth.
PRs are welcome and much appreciated that keeps this plugin up to date with Capacitor and official Google Auth platform library feature parity.
Try to follow good code practices. You can even help keeping the included demo updated.
PRs for features that are not aligned with the official Google Auth library are discouraged.
(We are beginner-friendly here)
npm i --save @codetrix-studio/capacitor-google-auth
npx cap update
If need migrate to different Capacitor versions see instruction for migrate plugin to new version.
Register plugin and manually initialize
import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth';
// use hook after platform dom ready
GoogleAuth.initialize({
clientId: 'CLIENT_ID.apps.googleusercontent.com',
scopes: ['profile', 'email'],
grantOfflineAccess: true,
});
or if need use meta tags (Optional):
<meta name="google-signin-client_id" content="{your client id here}" />
<meta name="google-signin-scope" content="profile email" />
clientId
- The app's client ID, found and created in the Google Developers Console.scopes
– same as Configure scopesgrantOfflineAccess
– boolean, default false
, Set if your application needs to refresh access tokens when the user is not present at the browser.Use it
GoogleAuth.signIn();
init hook
// app.component.ts
constructor() {
this.initializeApp();
}
initializeApp() {
this.platform.ready().then(() => {
GoogleAuth.initialize()
})
}
sign in function
async googleSignIn() {
let googleUser = await GoogleAuth.signIn();
const credential = auth.GoogleAuthProvider.credential(googleUser.authentication.idToken);
return this.afAuth.auth.signInAndRetrieveDataWithCredential(credential);
}
// App.vue
import { defineComponent, onMounted } from 'vue';
import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth';
export default defineComponent({
setup() {
onMounted(() => {
GoogleAuth.initialize();
});
const logIn = async () => {
const response = await GoogleAuth.signIn();
console.log(response);
};
return {
logIn,
};
},
});
or see more CapacitorGoogleAuth-Vue3-example
Create in Google cloud console credential Client ID for iOS and get Client ID and iOS URL scheme
Add identifier REVERSED_CLIENT_ID
as URL schemes to Info.plist
from iOS URL scheme
(Xcode: App - Targets/App - Info - URL Types, click plus icon)
Set Client ID one of the ways:
capacitor.config.json
iosClientId
- specific key for iOSclientId
- or common key for Android and iOSGoogleService-Info.plist
file with CLIENT_ID
and copy to ios/App/App necessarily through Xcode for indexing.plugin first use iosClientId
if not found use clientId
if not found use value CLIENT_ID
from file GoogleService-Info.plist
Set Client ID :
In capacitor.config.json
androidClientId
- specific key for AndroidclientId
- or common key for Android and iOSor set inside your strings.xml
plugin first use androidClientId
if not found use clientId
if not found use value server_client_id
from file strings.xml
<resources>
<string name="server_client_id">Your Web Client Key</string>
</resources>
Name | Type | Description |
---|---|---|
clientId | string | The app's client ID, found and created in the Google Developers Console. |
iosClientId | string | Specific client ID key for iOS |
androidClientId | string | Specific client ID key for Android |
scopes | string[] | Scopes that you might need to request to access Google APIs https://developers.google.com/identity/protocols/oauth2/scopes |
serverClientId | string | This ClientId used for offline access and server side handling |
forceCodeForRefreshToken | boolean | Force user to select email address to regenerate AuthCode used to get a valid refreshtoken (work on iOS and Android) |
Provide configuration in root capacitor.config.json
{
"plugins": {
"GoogleAuth": {
"scopes": ["profile", "email"],
"serverClientId": "xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
"forceCodeForRefreshToken": true
}
}
}
or in capacitor.config.ts
/// <reference types="'@codetrix-studio/capacitor-google-auth'" />
const config: CapacitorConfig = {
plugins: {
GoogleAuth: {
scopes: ['profile', 'email'],
serverClientId: 'xxxxxx-xxxxxxxxxxxxxxxxxx.apps.googleusercontent.com',
forceCodeForRefreshToken: true,
},
},
};
export default config;
for Android
in file MainActivity.onCreate
- this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
- add(GoogleAuth.class);
- }});
+ this.registerPlugin(GoogleAuth.class);
Install version 3.2.x:
npm i --save @codetrix-studio/capacitor-google-auth
Follow instruction for you project Updating from Capacitor 3 to Capacitor 4.
- GoogleAuth.init()
+ GoogleAuth.initialize()
Install version 3.x.x:
npm i --save @codetrix-studio/capacitor-google-auth@3
After migrate to Capcitor 3 updating you projects, see diff:
- import "@codetrix-studio/capacitor-google-auth";
- import { Plugins } from '@capacitor/core';
+ import { GoogleAuth } from '@codetrix-studio/capacitor-google-auth'
- Plugins.GoogleAuth.signIn();
+ GoogleAuth.init()
+ GoogleAuth.signIn()
Install version 2.x.x:
npm i --save @codetrix-studio/capacitor-google-auth@2
for capacitor 2.x.x use instruction
FAQs
Google Auth plugin for capacitor.
The npm package @iruthayaj/capacitor-google-auth receives a total of 1 weekly downloads. As such, @iruthayaj/capacitor-google-auth popularity was classified as not popular.
We found that @iruthayaj/capacitor-google-auth demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.