1.0.1 • Published 3 years ago

facebook-login-react-component v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

facebook-login-react-component

A React component for Facebook Login

Background

This component is based on the code found here. When I tried to use that component in my project it didn't work for React 17 and it seems like it is no longer maintained, therefore I created this project. This allowed me to use it in my project and as a way to learn how to build React components.

I'm not attempting to pass this off as my own and I'm willing remove this package when the original is maintained.

Getting Started

  • yarn add facebook-login-react-component or npm install facebook-login-react-component

Development

git clone https://github.com/sb89/facebook-login-react-component.git && cd facebook-login-react-component
npm install
npm start
cd example <new tab>
npm install
npm start

How to Use

Basic button with styling

import React from 'react';
import ReactDOM from 'react-dom';
import { FacebookLoginWithButton } from 'facebook-login-react-component';

const responseFacebook = (response) => {
  console.log(response);
}

ReactDOM.render(
  <FacebookLoginWithButton
    appId="1088597931155576"
    autoLoad={true}
    fields="name,email,picture"
    callback={responseFacebook} />,
  document.getElementById('demo')
);

Facebook button without styling

If you're providing all your own custom styling, you can use the render prop build. This build doesn't include any CSS or additional code needed to customise the look of the button, and instead leaves that entirely up to you. You can see an example of this in demo/index.js.

To make sure you import the right version, you will need to update your import line:

import { FacebookLogin } from 'facebook-login-react-component'

<FacebookLogin
  appId="1088597931155576"
  autoLoad
  callback={responseFacebook}
  render={renderProps => (
    <button onClick={renderProps.onClick}>This is my custom FB button</button>
  )}
/>

The render function will be passed the following properties for you to use:

  • onClick
  • isDisabled
  • isProcessing
  • isSdkLoaded

Custom CSS Class and Icon

By default fontawesome is included, If you don't want to use default fontawesome icons, you can send an element in icon attribute

Fontawesome example:

import React from 'react';
import ReactDOM from 'react-dom';
import { FacebookLoginWithButton } from 'facebook-login-react-component';

const responseFacebook = (response) => {
  console.log(response);
}

ReactDOM.render(
  <FacebookLogin
    appId="1088597931155576"
    autoLoad={true}
    fields="name,email,picture"
    callback={responseFacebook}
    cssClass="my-facebook-button-class"
    icon="fa-facebook"
  />,
  document.getElementById('demo')
);

Custom element example:

import React from 'react';
import ReactDOM from 'react-dom';
import { FacebookLoginWithButton } from 'facebook-login-react-component';
import TiSocialFacebookCircular from 'react-icons/lib/ti/social-facebook-circular';

const responseFacebook = (response) => {
  console.log(response);
}

ReactDOM.render(
  <FacebookLogin
    appId="1088597931155576"
    autoLoad={true}
    fields="name,email,picture"
    callback={responseFacebook}
    cssClass="my-facebook-button-class"
    icon={<TiSocialFacebookCircular />}
  />,
  document.getElementById('demo')
);

Custom permission

By default the component, request only 'public_profile' permission, you can change if you send 'scope', that is a string comma separated attribute.

see https://developers.facebook.com/docs/facebook-login/permissions for permissions list

  import React from 'react';
  import { FacebookLoginWithButton } from 'facebook-login-react-component';

  class MyComponent extends React.Component {
    responseFacebook(response) {
      console.log(response);
    }

    render() {
      return (
        <FacebookLogin
          appId="1088597931155576"
          autoLoad={true}
          fields="name,email,picture"
          scope="public_profile,user_friends,user_actions.books"
          callback={this.responseFacebook}
        />
      )
    }
  }

  export default MyComponent;

Server

'use strict';

import React from 'react';
import { FacebookLoginWithButton } from 'facebook-login-react-component';

class MyComponent extends React.Component {
  responseFacebook(response) {
    console.log(response)
  }

  render() {
    return (
      <FacebookLogin
        appId="1088597931155576"
        autoLoad={true}
        fields="name,email,picture"
        callback={this.responseFacebook}
      />
    )
  }
}

export default MyComponent;

Parameters

paramsvaluedefault value
appIdstringRequired
sizestringsmall - medium - metro
scopestringpublic_profile, email, user_birthday
fieldsstringname,email,picture
callbackfunctionresultFacebookLogin
returnScopesbooleanfalse
autoLoadbooleanfalse
xfbmlbooleanfalse
cookiebooleanfalse
textButtonstringLogin with Facebook
cssClassstringkep-login-facebook kep-login-facebook-button-size
redirectUristringwindow.location.href (mobile-only)
versionstring9.0
iconstringelementnone
languagestringen_US
onClickfunctionInitial click on the component
isMobilebooleandetected via userAgent
disableMobileRedirectbooleanfalseset to true for popup authentication on mobile devices
isDisabledbooleanfalse
tagstringHTML Element, Ex: 'a', 'button'
onFailurefunctionoptional function to separatere the failed init
statestringoptional string to maintain state between the request and callback. This parameter should be used for preventing Cross-site Request Forgery and will be passed back to you, unchanged, in your redirect URI
authTypestringoptional string to change authentication type
responseTypestringoptional string to change response type. Default value is 'code'
1.0.1

3 years ago

1.0.0

3 years ago