rll

react-linkedin-login-oauth2

Easily get Authorization Code from Linked In to log in without redirecting.

Showing:

Popularity

Downloads/wk

3.6K

GitHub Stars

45

Maintenance

Last Commit

8mos ago

Contributors

4

Package

Dependencies

1

Size (min+gzip)

3.4KB

License

MIT

Type Definitions

Tree-Shakeable

Yes?

Readme

React Linked In Login Using OAuth 2.0

All Contributors

npm package

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

This package is used to get authorization code for Linked In Log in feature using OAuth2 in a easy way. 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 Usage and Demo for instruction.

Table of contents

Changelog

See CHANGELOG.md

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';
import linkedin from 'react-linkedin-login-oauth2/assets/linkedin.png'

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={linkedin} 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

Props

LinkedIn component:

Parametervalueis requireddefault
clientIdstringyes
redirectUristringyes
scopestringyes'r_emailaddress'
See your app scope in https://www.linkedin.com/developers/apps/${yourAppId}/auth
onSuccessfunctionyes
onFailurefunctionyes
classNamestringno'btn-linkedin'
styleobjectno
disabledbooleannofalse
onClickfunctionno
childrenfunctionnoLinked in Signin button
renderElementfunctionnoRender prop to use a custom element, use props.onClick
supportIEbooleannofalse
redirectPathfunctionno/linkedin

Read more about props here https://docs.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow?context=linkedin/context#step-2-request-an-authorization-code

LinkedinPopUp component:
No parameters needed

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

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Hung Viet Nguyen

💻

Nguyễn Duy Khánh

💻

YBeck

💻

Mehdi Raza

🤔

Phillip Denness

🐛

dsp.iam

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100