Skip to content

Easily get Authorization Code from Passport Auth flow to log in without redirecting.

Notifications You must be signed in to change notification settings

airmeet/react-passport-login-oauth2

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React Linked In Login Using OAuth 2.0

npm package

Demo: https://stupefied-goldberg-b44ee5.netlify.com/

This package is used to get authorization code for Linked In Log in feature using OAuth2 in a easy way, without redirecting your application to linked in authorization page. After have the authorization code, you can send it to server to continue to get information needed. For more, please see at Authenticating with OAuth 2.0 - Linked In
See demo/src/index.js for examples.

Table of contents

Changelog

1.0.7

  • Remove unnecessary console.log
  • Be able to render custom element (Thank @YBeck for your contribution)
  • Support IE11, please see #support-ie for more detail
  • Check state to avoid CSRF attack

Installation

npm install --save react-linkedin-login-oauth2

Overview

We will create a Linked In button (using LinkedIn component), after clicking on this button, a popup window will show up and ask for the permission. After we accepted, the pop up window will redirect to a specified URI which should be routed to LinkedInPopUp component. It has responsible to notice our openning app the authorization code Linked In provides us. You can consider using react-router-dom as a possible solution.

Usage

First, we create a button and provide required props

import React, { Component } from 'react';

import { LinkedIn } from 'react-linkedin-login-oauth2';

class LinkedInPage extends Component {
  state = {
    code: '',
    errorMessage: '',
  };


  handleSuccess = (data) => {
    this.setState({
      code: data.code,
      errorMessage: '',
    });
  }

  handleFailure = (error) => {
    this.setState({
      code: '',
      errorMessage: error.errorMessage,
    });
  }
  
  render() {
    const { code, errorMessage } = this.state;
    return (
      <div>
        <LinkedIn
          clientId="81lx5we2omq9xh"
          onFailure={this.handleFailure}
          onSuccess={this.handleSuccess}
          redirectUri="http://localhost:3000/linkedin"
        >
          <img src={require('./assets/linkedin.png')} alt="Log in with Linked In" style={{ maxWidth: '180px' }} />
        </LinkedIn>
        {!code && <div>No code</div>}
        {code && <div>Code: {code}</div>}
        {errorMessage && <div>{errorMessage}</div>}
      </div>
    );
  }
}

export default LinkedInPage;

Then we define a route to redirect_url and pass LinkedInPopUp to it as follow:

import React, { Component } from 'react';
import { LinkedInPopUp } from 'react-linkedin-login-oauth2';

import { render } from 'react-dom';
import { BrowserRouter, Route, Switch } from 'react-router-dom';
import LinkedInPage from './LinkedInPage';

class Demo extends Component {
  render() {
    return (
      <BrowserRouter>
        <Switch >
          <Route exact path="/linkedin" component={LinkedInPopUp} />
          <Route path="/" component={LinkedInPage} />
        </Switch>
      </BrowserRouter>
    );
  }
}

Usage with custom button

You can render your own component by provide renderElement as following example:

<LinkedIn
  clientId="81lx5we2omq9xh"
  onFailure={this.handleFailure}
  onSuccess={this.handleSuccess}
  redirectUri="http://localhost:3000/linkedin"
  renderElement={({ onClick, disabled }) => (
    <button onClick={onClick} disabled={disabled}>Custom linkedin element</button>
  )}
/>

Support IE

Earlier, this package might not work in IE11. The reason is that if popup and opener do not have same domain, popup cannot send message to opener. For more information about this, please visit here. From 1.0.7, we can bypass this by open a popup to our page, then redirect to Linked In authorization page, it should work fine. IE11 is supported in 1.0.7. Following is step to support it. (If you don't have need to support IE, please ignore this part)

  1. Pass prop supportIE
  2. Pass redirectPath which has path route to LinkedinPopUp component, default value is /linkedin (for above example, <Route exact path="/linkedin" component={LinkedInPopUp} /> => redirectPath="/linkedin")
<LinkedIn
  ...
  supportIE
  redirectPath="/linkedin"
  ...
/>

Demo

You can see demo via this https://github.com/nvh95/react-linkedin-login-oauth2/tree/master/demo/src
Demo 1: Use react-router-dom
Demo 2: Not use react-router-dom
Or run

git clone https://github.com/nvh95/react-linkedin-login-oauth2
cd react-linkedin-login-oauth2
npm start

Or via this link: https://stupefied-goldberg-b44ee5.netlify.com/

Props

LinkedIn component:

Parameter value is required default
clientId string yes
redirectUri string yes
scope string no Default member permissions defined in application configuration
state string no fdsf78fyds7fm
onSuccess function yes
onFailure function yes
className string no 'btn-linkedin'
disabled boolean no false
onClick function no
children function no Linked in Signin button
renderElement function no Render prop to use a custom element, use props.onClick
supportIE boolean no false
redirectPath function no /linkedin

Read more about props here https://developer.linkedin.com/docs/oauth2

LinkedinPopUp component:
No parameters needed

Contribution

All helps are welcome. Please open a PR and describe what do you want to improve.

I would like to thank @Songuku95 and @YBeck for your contributions to this package.

Issues

Please create an issue at https://github.com/nvh95/react-linkedin-login-oauth2/issues. I will spend time to help you.

Failed to minify the code from this file: ./node_modules/react-linkedin-login-oauth2/node_modules/query-string/index.js:8

Please upgrade react-linkedin-login-oauth2 to latest version following

npm install --save react-linkedin-login-oauth2

Known issue

About

Easily get Authorization Code from Passport Auth flow to log in without redirecting.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • JavaScript 98.2%
  • CSS 1.8%