Skip to content

Latest commit

 

History

History
175 lines (137 loc) · 8.85 KB

README.md

File metadata and controls

175 lines (137 loc) · 8.85 KB

react-native-linkedin

🔗 React-Native LinkedIn

Simple LinkedIn login library for React-Native with WebView into a Modal


Demo on Expo


Benefits

  • Light: No need to link a native library like others alternatives
  • Simple: Get the token and the expires, you handle your own login with the access_token
  • Sure: open-source
  • Almost readable & understandable code: JavaScript & React

Installation

$ yarn add react-native-linkedin

Documentation

Props

Name Type Required Default Description
clientID string required Your client id
clientSecret string Will be removed from here and give server example Your client secret
redirectUri string required Your redirectUri
onSuccess function required Function will be call back on success
authState string optional require('uuid').v4() The state of auth, to be more secure
onError function optional console.error(err) Function will be call back on error
onClose function optional Function will be call back on close modal
onOpen function optional Function will be call back on open modal
onSignIn function optional Function will be call back when the user sign in
permissions array optional ['r_basicprofile', 'r_emailaddress'] The LinkedIn access token permissions
renderButton function optional Render function for customize LinkedIn button
renderClose function optional Render function for customize close button
linkText string optional 'Login with LinkedIn' Link label
containerStyle ViewPropTypes.style optional Customize container style
wrapperStyle ViewPropTypes.style optional Customize wrapper style
closeStyle ViewPropTypes.style optional Customize close style
animationType Modal.propTypes.animationType optional fade Customize animationType style: 'none', 'slide' or 'fade'
shouldGetAccessToken bool optional true Set to false to receive the 'authorization code' rather then the 'access token'

Example

// See ./example folder for details
import React from 'react'
import { StyleSheet, View } from 'react-native'

import LinkedInModal from 'react-native-linkedin'

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: '#fff',
    justifyContent: 'center',
    alignItems: 'center',
  },
})

export default class AppContainer extends React.Component {
  render() {
    return (
      <View style={styles.container}>
        <LinkedInModal
          clientID="[ Your client id from https://www.linkedin.com/developer/apps ]"
          clientSecret="[ Your client secret from https://www.linkedin.com/developer/apps ]"
          redirectUri="[ Your redirect uri set into https://www.linkedin.com/developer/apps ]"
          onSuccess={token => console.log(token)}
        />
      </View>
    )
  }
}

Security

Please note that you should give your linkedin client id and you secret key to the component. You should be aware that key can be found if you store it directly to your code. I strongly recommand to not declare both on your code but found a way to keep it secret (ie. get it from server, encrypt it, ...)

> Related issue

Roadmap & TODOs

  • Better style for modal: border, padding, transparency
  • Button to close the modal
  • Better catch of error into login url
  • Add gif example in README
  • Publish example to expo
  • Remove secret from client and give server example of retrieving access_token
  • Test every line of code
  • Add props or other function to fetch more informations like basic profile information
  • Use Expo WebBrowser when app is in Expo (ie. if global.__exponent exist)

> Propose

Contribution

PRs are welcome!

FAQ

Is it supported and tested both on android and iOS?

YES

How to get the basic profile of a user after getting the token?

const access_token // from this lib
const baseApi = 'https://api.linkedin.com/v1/people/'
const params = [
  'first-name',
  'last-name',
  // add more fields here
]

const response = await fetch(
  `${baseApi}~:(${params.join(',')})?format=json`,
  {
    method: 'GET',
    headers: {
      Authorization: 'Bearer ' + access_token
    }
  }
)
const payload = await response.json()

Other questions

Feel free to contact me or create an issue

Alternatives

Licence

MIT

made with ♥