Skip to main content

Installation

There are two ways to consume the package:

Available exclusively to GitHub sponsors, this version offers:

✅ One-tap sign-in support for Android and Web, fully compatible (same API) with iOS

✅ Support for the React Native New Architecture, including the bridgeless mode.

✅ Enhanced API functionalities: synchronous methods and more, plus minor bugfixes.

✅ Comprehensive documentation available on this site.

Your sponsorship enables continued maintenance and development of the module. Thank you for supporting this project! ❤️

Public Version​

Available on the public npm registry, this version does not include the features, updates and bugfixes found in the sponsor-only version.

Please note that this documentation site covers the sponsor-only version. If you're using the public version, please refer to this readme.

Accessing the private package for sponsors​

Upon sponsoring (please use specifically the tiers that mention this project!), you will get immediate access * to the private package and to the private repo with the sources and examples.

Three steps are needed to access the sponsored package, which is hosted on GitHub npm packages registry.

  1. Become a sponsor and accept private repository invitation * - it takes just a few clicks.

  2. Obtain here a Personal Access Token with packages:read permission.

  3. Set up your package manager so that it fetches the package from the GH packages registry. In this example, we're using an NPM_TOKEN_GOOGLE_SIGN_IN environment variable.

create a .npmrc file in your project root with the following content:

//npm.pkg.github.com/:_authToken=${NPM_TOKEN_GOOGLE_SIGN_IN}

@react-native-google-signin:registry=https://npm.pkg.github.com/

If you use another package manager (such as bun), please refer to its documentation on how to set up a custom registry.

Requirements​

The package requires React Native 0.60 or higher.

If you're using the New Architecture, you need to be on React Native 0.72 or higher.

Installing​

yarn add @react-native-google-signin/google-signin

There are several guides to follow now:

Invitation Note​

As a sponsor, you will be added automatically if you sponsor from a personal account. If you sponsor from an organization account, please let me know and I'll add you manually. This is because of how GitHub handles this case.