[npm:img]: https://img.shields.io/npm/v/react-social-login.svg?style=flat-square [npm:url]: https://www.npmjs.org/package/react-social-login [standard:img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square [standard:url]: http://standardjs.com [dependencies:img]: https://david-dm.org/deepakaggarwal7/react-social-login.svg?style=flat-square [dependencies:url]: https://github.com/deepakaggarwal7/react-social-login/blob/master/package.json#L33 [license:img]: https://img.shields.io/badge/License-MIT-brightgreen.svg?style=flat-square [license:url]: https://opensource.org/licenses/MIT ![alt text](https://raw.githubusercontent.com/deepakaggarwal7/react-social-login/master/react-social-login-logo.png) # React Social Login · [![NPM version][npm:img]][npm:url] · [![Standard - JavaScript Style Guide][standard:img]][standard:url] · [![Dependencies][dependencies:img]][dependencies:url] · [![License: MIT][license:img]][license:url] React Social Login is an HOC which provides social login through multiple providers. **Currently supports Amazon, Facebook, GitHub, Google, Instagram and ~~LinkedIn~~ as providers (more to come!)** \*LinkedIn has deprecated it's JS SDK. Hence, not supported anymore. ## IMPORTANT: Google is deprecating its JS library on 31-Mar-2023 in favour of new Google Identity Service. GIS deprecates many of the methods used in our library. While we are exploring possibility of integrating new GIS, but there's no guarantee (as of now) and it is recommended to switch to GIS instead of this library if it is a business blocker for you. ## Motivation - Having a component that doesn't dictates the HTML - All-in-One login component for different social providers - Takes care of warnings from provider's SDKs when multiple instances are placed - Kind of re-birth of my previous .Net driven similar open source - SocialAuth.NET ## Scopes While this library does a good job of fetching basic profile, at times you might need to get additional attributes from providers like DateOfBirth, HomeTowm, etc. which aren't returned by default. Scopes are purely provider dependent and their documentation is the best place to look for supported scopes and literal to be passed as argument. You can pass those scopes using the scope tag. For example, if you want birth date from Facebook (which isn't returned by default), you'd add following scope to your tag: ```js scope = "user_birthday,user_hometown"; ``` Below are some links to official scopes guide for a few providers: - [FACEBOOK](https://developers.facebook.com/docs/facebook-login/permissions/) - [GOOGLE](https://developers.google.com/identity/protocols/googlescopes) ## Online demo See [https://deepakaggarwal7.github.io/react-social-login](https://deepakaggarwal7.github.io/react-social-login). ## Demo Edit `appId` props with your own ones in `demo/index.js` file and build demo: ```shell $ npm start ``` You can then view the demo at [https://localhost:8080][demo]. For GitHub provider, see [GitHub specifics][githubspecifics] first. ## Install ```shell $ npm install --save react-social-login ``` ## Usage Create the component of your choice and transform it into a SocialLogin component. **SocialButton.js** ```js import React from "react"; import SocialLogin from "react-social-login"; class SocialButton extends React.Component { render() { const { children, triggerLogin, ...props } = this.props; return ( ); } } export default SocialLogin(SocialButton); ``` Then, use it like a normal component. **index.js** ```js import React from "react"; import ReactDOM from "react-dom"; import SocialButton from "./SocialButton"; const handleSocialLogin = (user) => { console.log(user); }; const handleSocialLoginFailure = (err) => { console.error(err); }; ReactDOM.render(

, document.getElementById("app") ); ``` ### Optional Loader Component There are times when initialization of a component can take longer than expected. To support these changes there is the optional loader component. Simply pass the component as a second parameter to SocialLogin **SocialButton.js** ```js import React from "react"; import SocialLogin from "react-social-login"; import Loading from "./Loading"; class SocialButton extends React.Component { render() { const { children, triggerLogin, ...props } = this.props; return ( ); } } export default SocialLogin(SocialButton, Loading); ``` ### Reference Raw component props (before transform): | Prop | Default | Type / Values | Description | | ----------------- | ------- | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | appId | — | string | Your app identifier (see [find my appId][findmyappid]) | | autoCleanUri | false | boolean | Enable auto URI cleaning with OAuth callbacks | | autoLogin | false | boolean | Enable auto login on `componentDidMount` | | gatekeeper | — | string | Gatekeeper URL to use for GitHub OAuth support (see [GitHub specifics][githubspecifics]) | | getInstance | — | function | Return node ref like `ref` function would normally do ([react known issue](https://github.com/facebook/react/issues/4213)) | | onLoginFailure | — | function | Callback on login fail | | onLoginSuccess | — | function | Callback on login success | | onLogoutFailure | — | function | Callback on logout fail (`google` only) | | onLogoutSuccess | — | function | Callback on logout success | | onInternetFailure | — | function | Doesn't open popup if returns false and internet isn't there | | provider | — | `amazon`, `facebook`, `github`, `google`, `instagram`, ~~`linkedin`~~ | Social provider to use | | redirect | - | string | URL to redirect after login (available for `github` and `instagram` only) | | scope | - | array, string | An array or string of scopes to be granted on login. | | version | - | string | Can be used to explicitly specify FBsdk version (default is v5.0) | | any other prop | — | — | Any other prop will be forwarded to your component | _Note about `redirect`: if you are redirecting on root (eg: https://localhost:8080), you **have** to omit the trailing slash._ Transformed component props: | Prop | Type | Description | | -------------- | -------- | ---------------------------------------------------------------------------------------- | | triggerLogin | function | Function to trigger login process, usually attached to an event listener | | triggerLogout | function | Function to trigger logout process, usually attached to a container handling login state | | all your props | — | All props from your original component, minus SocialLogin specific props | ### Logout To implement logout, we need a container handling login state and triggering logout function from a `ref` to `SocialLogin` component. As it is implemented in the demo, we have two components working together to trigger logout: - [`Demo` container][democontainer] - [`UserCard` component][usercardcomponent] Here is how they work together: 1. [`Demo` is displaying `UserCard` only if user is logged][logoutstep1] 2. [`UserCard` gets forwarded a `logout` function][logoutstep2] 3. [`UserCard` calls forwarded `logout` prop on click on the logout button][logoutstep3] 4. [`logout` function triggers `triggerLogout` prop from a ref to SocialLogin component][logoutstep4] ### Old component support We decided to keep the old behavior as a fallback, it only supports `facebook`, `google` and `linkedin` providers and is available as a named export: ```js import React from "react"; import ReactDOM from "react-dom"; import { OldSocialLogin as SocialLogin } from "react-social-login"; const handleSocialLogin = (user, err) => { console.log(user); console.log(err); }; ReactDOM.render(

, document.getElementById("app") ); ``` ## Build Though not mandatory, it is recommended to use latest npm5 to match lockfile versions. ```shell $ npm install $ npm run build ``` ## Miscellaneous ### Find my appId #### Amazon See [Amazon developers documentation][amazondoc]. #### Facebook See [facebook for developers documentation][fb4devdoc]. #### GitHub (see [GitHub specifics][githubspecifics]) - Basic authentication method using personal access tokens: see [GitHub Help][githubhelp]. - OAuth authentication: see [GitHub Developer guide][githubdoc]. #### Google See [Google Sign-In for Websites guide][gsignindoc]. #### Instagram See [Instagram developers documentation][instadoc]. #### LinkedIn See `Where can I find my API key?` section on the [FAQ][linkedinfaq]. ### GitHub specifics GitHub provider is implemented in two different modes: - One using [GitHub Personal Tokens][ghpersonaltokens] - Another using GitHub OAuth #### GitHub Personal Tokens mode Actually, this one is more a hacky way to get user profile than a way to really _connect_ your app like OAuth does. Plus, it requires from users to create their personal token from their GitHub account, which is not a good experience for them. This mode is the default if you do not provide `gatekeeper` prop and will try to use the `appId` prop to get user data. Anyway, we **strongly advise you to use the GitHub OAuth authentication flow**. #### GitHub OAuth If you provide a `gatekeeper` prop, this mode will be active and will use a server of your own to fetch GitHub OAuth access token. This is a [know issue of GitHub][ghoauthwebflowissue]. The simplest way to setup this mode is to use the [Gatekeeper project][gatekeeper]. Just follow setup instructions then tell RSL to use it: ``` Login with GitHub OAuth ``` You can also implement it your own way but you must use the same routing than `Gatekeeper` (`/authenticate/:code`) and return a JSON response containing a `token` or `error` property (it will also throw if it doesn't find `token`). #### Special instructions to run demo RSL demo is served over https with `webpack-dev-server`. This is a requirement of Amazon Login SDK. `Gatekeeper` is served over insecure http so you will have to serve the demo through http also to work with GitHub (but it will break Amazon): ```shell $ npm run start:insecure ``` ## FAQs - How to get a bigger picture in FB? =use **/me/picture?width=999** ## Change Log **v2.0.0** [26 Feb 2017] - Use small case for providers - Linkedin support added along with previous google and facebook - A lot of refactoring done - Uses Webpack 2.x **Huge Thanks to Nicolas Goudry for his generous contribution ** **v2.0.1** [24 June 2017] merged pull request [#15](https://github.com/deepakaggarwal7/react-social-login/pull/15) - Facebook error - code styling - unnecessary console logs - pre-commit lint **v3.0.0** [30 July 2017] merged pull request [#19](https://github.com/deepakaggarwal7/react-social-login/pull/19) - Rewrote as HOC - Instagram - GitHub - Auto login - Better error handling - Various fixes **v3.1.0** [01 August 2017] merged pull request [#20](https://github.com/deepakaggarwal7/react-social-login/pull/20) - Amazon - https **v3.2.0** [14 September 2017] 3.2.0 - Custom Google scopes - Multiple Google buttons - GitHub doc **v3.2.1** [06 October 2017] React 16, better build, update dep, additions and fixes - Update React to v16 - Update all dependencies to latest stable versions - Optimize webpack build - Return full googleAuthResponse - Preserve redirect url query string and hash - Cancel loading on componentWillUnmount - Various fixes **v3.3.0** [22 October 2017] Logout, custom scopes and fixes - Add publicProfileURL for LinkedIn - Add logout support - Fix wrong GitHub id - Add custom scope support (all but LinkedIn) - Update documentation **v3.4.0** [22 October 2017] Fix logout issues, expose wrapped component ref and fixes - Fix logout issue with Amazon - Don’t throw error on Instagram logout (like fake SDK load doesn’t throw) - Expose wrapped component ref ([react know issue](https://github.com/facebook/react/issues/4213)) - Small fixes **v3.4.1** [08 November 2017] Fix logout issues, adds SSR support and fixes - Fix unknown prop `triggerLogout` forwarded to wrapped component - Server-side rendering support - Small fixes - Update README to explain how logout is implemented in demo **v3.4.2** [26 December 2017] Fix SSR, refs and update build - Fixes url parser when window is undefined (SSR fix) - Don’t use refs on stateless components - Update build system (`babel-preset-env`, updated dependencies, lighter npm package) **v3.4.3** [23 December 2018] merged pull request [#112](https://github.com/deepakaggarwal7/react-social-login/pull/112) - Github ID now avilable (Thanks to [MuhamadOmr](https://github.com/deepakaggarwal7/)) **v3.4.5** [25 Sep 2019] merged pull request [#135](https://github.com/deepakaggarwal7/react-social-login/pull/135) - Types added (Thanks to [Daria Moreno-Gogoleva](https://github.com/iwanttobealight)) **v3.4.6** [30 Oct 2019] merged pull request, logo added [#143](https://github.com/deepakaggarwal7/react-social-login/pull/143) - Example button fixed(Thanks to [https://github.com/xzessmedia](https://github.com/xzessmedia)) **v3.4.7** [07 May 2020] Fb version upgrade, more control on github scopes - [#142](https://github.com/deepakaggarwal7/react-social-login/pull/142) fixed! Thanks to [John](https://github.com/johndavedecano) - **Github users** - Earlier if any github scope was specified, it was concatenated with the default user scope. However, [csweaver](https://github.com/csweaver) raised a good point in bug [#95](https://github.com/deepakaggarwal7/react-social-login/pull/95) and there was a good solution from [Lennart](https://github.com/lennartkramer1988) which is implemented. Thanks to them! - [#140](https://github.com/deepakaggarwal7/react-social-login/pull/140) Fixed Move react and blueprint dependencies to peer. Thanks to [Oumar](https://github.com/wattazoum) **v3.4.8** [07 July 2020] Gender pulled for Google - [#163](https://github.com/deepakaggarwal7/react-social-login/pull/163) fixed! Thanks to [Tanya](https://github.com/TanyaTPG) **v3.4.9** [03 August 2020] types included in dist and example functional component added **v3.4.10** [30 September 2020] types included in dist and example functional - Fixes #61 - Button shows without sdk getting loaded - Fixes #173 - Fb demo app broken **v3.4.13** [06 March 2021] onInternetFailure, explicit FB version, Webpack - Fixes #55 - Button shows without sdk getting loaded - Fixes #170 - Facebook SDK upgraded to v5.0. Can be overriden using version prop. - Fixes #180 - README.md updated to remove triggerLogin prop warning - Webpack issues fixed - Fixes #191 - use this instead of 3.4. 12 if you are using nextjs **v3.4.14** [25 Jul 2021] merged [pr/122](https://github.com/deepakaggarwal7/react-social-login/commit/095041d34f66145fdf6bfbd53f930bc33b29dbcf) - Fixes #105,109 - User closes login popup handled **v3.4.15** [26 Dec 2021] merged [pr/219](https://github.com/deepakaggarwal7/react-social-login/pull/219) - Ability to add optional loader component. Thanks to [Kartik](https://github.com/karthikdivi) **v3.4.16** [26 Nov 2022] - Fixes #228 based on comment from [ewinata](https://github.com/ewinata) ## Tests TBD ## Main contributors - [Deepak Aggarwal][ghdeepak] - [Nicolas Goudry][ghngoudry] ## Kind contributors - Kamran Ahmed : custom Google scopes - Adrien Cohen : multiple Google buttons - Jason Loo : full google auth response - Andri Janusson : LinkedIn public profile URL - Adrien Pascal : SSR support - [jimrroberts] : Types and cleanup [demo]: https://localhost:8080 [findmyappid]: #find-my-appid [fb4devdoc]: https://developers.facebook.com/docs/apps/register [githubhelp]: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line [githubdoc]: https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps [gsignindoc]: https://developers.google.com/identity/sign-in/web/devconsole-project [instadoc]: https://www.instagram.com/developer [linkedinfaq]: https://developer.linkedin.com/support/faq [ghpersonaltokens]: https://github.com/blog/1509-personal-api-tokens [ghoauthwebflowissue]: https://github.com/isaacs/github/issues/330 [gatekeeper]: https://github.com/prose/gatekeeper [githubspecifics]: #github-specifics [amazondoc]: https://developer.amazon.com/public/apis/engage/login-with-amazon/docs/register_web.html [googlescopes]: https://developers.google.com/identity/protocols/googlescopes [ghngoudry]: https://github.com/nicolas-goudry [ghdeepak]: https://github.com/deepakaggarwal7 [jimrroberts]: https://github.com/jimrroberts [democontainer]: https://github.com/deepakaggarwal7/react-social-login/blob/master/demo/containers/demo.js [usercardcomponent]: https://github.com/deepakaggarwal7/react-social-login/blob/master/demo/components/userCard.js [logoutstep1]: https://github.com/deepakaggarwal7/react-social-login/blob/master/demo/containers/demo.js#L73 [logoutstep2]: https://github.com/deepakaggarwal7/react-social-login/blob/master/demo/containers/demo.js#L62 [logoutstep3]: https://github.com/deepakaggarwal7/react-social-login/blob/master/demo/components/userCard.js#L121 [logoutstep4]: https://github.com/deepakaggarwal7/react-social-login/blob/master/demo/containers/demo.js#L66

	Stars	Issues	Version	Updated	Created
google-auth-library	1,649	40	9.10.0	3 days ago	9 years ago
react-google-login			5.2.2	3 years ago	8 years ago
react-social-login			3.4.17	a year ago	8 years ago
react-social-login-buttons	202	6	4.1.0	3 months ago	7 years ago

google-auth-library vs react-google-login vs react-social-login vs react-social-login-buttons

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past