npm package: @gcou/react-native-linkedin
Description: React-Native LinkedIn, a simple LinkedIn login library for React-Native with WebView and Modal - compatibility with RN 0.73
Author: Xavier Carpentier
Latest version: 2.5.0

<p align="center">
    <img alt="react-native-linkedin" src="https://thumbs.gfycat.com/IlliterateSecondDassie-size_restricted.gif" width=250>
</p>

<h3 align="center">
  🔗 React-Native LinkedIn
</h3>
<p align="center">
Simple <strong>LinkedIn</strong> login library for <strong>React-Native</strong> with <i>WebView</i> into a <i>Modal</i>
</p>
<p align="center">
  <a href="https://www.npmjs.com/package/react-native-linkedin"><img src="https://badge.fury.io/js/react-native-linkedin.svg"></a>
  <a href="https://www.npmjs.com/package/react-native-linkedin"><img src="https://img.shields.io/npm/dm/react-native-linkedin.svg?style=flat-square"></a>
  <a href="https://travis-ci.org/GaelCO/react-native-linkedin"><img src="https://api.travis-ci.com/GaelCO/react-native-linkedin.svg?branch=main"></a>
</p>

<br />

## 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

```bash
$ yarn add @gcou/react-native-linkedin
```

If your project uses expo >= 48, then you need to add expo-crypto to your project.
The [uuid](https://www.npmjs.com/package/uuid) library uses the Expo module if present. If Expo >= 48, then the crypto elements are in the expo-crypto module
```bash
$ yarn add expo-crypto
```

## Security

Please note that you should give your linkedin client id but not your secret key to this component.
You should be aware that key can be found if you store it directly to your code.
**I strongly recommend to not declare client secret key on your code but found a way to keep it secret**

- [> LinkedIn Documentation](https://docs.microsoft.com/en-us/linkedin/shared/api-guide/best-practices/secure-applications?context=linkedin/context#api-key-and-secret-key)

```tsx
  <LinkedInModal
    shouldGetAccessToken={false}
    clientSecret={null}
    clientID="[ Your client id from https://www.linkedin.com/developer/apps ]"
    redirectUri="[ Your redirect uri set into https://www.linkedin.com/developer/apps ]"
    onSuccess={({ authentication_code }) => console.log(`Post this ${authentication_code} to your server.`)}
  />
```

## Example

```JavaScript
// See ./App.tsx file for details
import React, {ReactElement, useRef} from 'react';
import {StyleSheet, View} from 'react-native';

import LinkedInModal from 'react-native-linkedin';
import LinkedInModalRef from 'react-native-linkedin';

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

export default function AppContainer() : ReactElement {
  linkedRef = useRef<LinkedInModalRef>(null);
  
  return (
    <View style={styles.container}>
      <LinkedInModal
        ref={this.linkedRef}
        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)}
      />
      <Button title="Log Out" onPress={this.linkedRef.current.logoutAsync()} />
    </View>
  )
}
```

## Props

| Name                     | Type                          | Required                                                                              | Default                             | Description                                                                                                                                                                                              |
| ------------------------ |-------------------------------| ------------------------------------------------------------------------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| clientID                 | string                        | **required**                                                                          |                                     | [Your client id](https://www.linkedin.com/developer/apps)                                                                                                                                                |
| 
clientSecret
      | string                        | use **shouldGetAccessToken={false}** and read **authorization_code** onSuccess return |                                     | Should not be stored in app [WARNING! Your client secret](https://docs.microsoft.com/en-us/linkedin/shared/api-guide/best-practices/secure-applications?context=linkedin/context#api-key-and-secret-key) |
| redirectUri              | string                        | **required**                                                                          |                                     | [Your redirectUri](https://www.linkedin.com/developer/apps)                                                                                                                                              |
| 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              | string[]                      | optional                                                                              | `'r_liteprofile', 'r_emailaddress'` | The LinkedIn access token permissions                                                                                                                                                                    |
| renderButton             | ReactElement                  | optional                                                                              |                                     | Render for customize LinkedIn button                                                                                                                                                            |
| renderClose              | ReactElement                  | optional                                                                              |                                     | Render for customize close button                                                                                                                                                               |
| linkText                 | string                        | optional                                                                              | `'Login with LinkedIn'`             | Link label                                                                                                                                                                                               |
| containerStyle           | StyleProp<ViewStyle>          | optional                                                                              |                                     | Customize container style                                                                                                                                                                                |
| wrapperStyle             | StyleProp<ViewStyle>          | optional                                                                              |                                     | Customize wrapper style                                                                                                                                                                                  |
| closeStyle               | StyleProp<ViewStyle>          | 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'                                                                                                                          |
| areaTouchText | object                        | optional       | `{top: 20, bottom: 20, left: 50, right: 50}`          | Set values for to increase the text touch area          |

## Contribution

- [@xcarpentier](mailto:contact@xaviercarpentier.com) The main author.

**PRs are welcome!**

## FAQ

### Is it supported and tested both on android and iOS?

**YES**

### How to logout react-native-linkedin?
```tsx
<View style={styles.container}>
    <LinkedInModal
      ref={this.linkedRef}
      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)}
    />
    <Button title="Log Out" onPress={this.linkedRef.current.logoutAsync()} />
</View>
```

## Alternatives

- [react-native-linkedin-login](https://www.npmjs.com/package/react-native-linkedin-login)
- [react-native-linkedin-sdk](https://www.npmjs.com/package/react-native-linkedin-sdk)
- [react-native-linkedin-oauth](https://www.npmjs.com/package/react-native-linkedin-oauth)

## Licence

[MIT](https://github.com/xcarpentier/react-native-linkedin/blob/master/LICENSE)

> made with ♥