5.0.3 • Published 4 years ago

react-facebook-login-typed v5.0.3

Weekly downloads
208
License
MIT
Repository
github
Last release
4 years ago

React Facebook Login

Just a note: The repository is forked from an existing one (https://github.com/keppelen/react-facebook-login), but with upgraded code and types included (for typescript)

Getting Started

  • yarn add react-facebook-login-typed or npm install react-facebook-login-typed
  • Your application will also need react-dom and react installed.

How to use

  import React, {useCallback} from 'react';
  import FacebookLogin from 'react-facebook-login-typed';

  const MyComponent = () => {
    const responseFacebook = useCallback(() => {
      console.log(response);
    }, []);

    return (
      <FacebookLogin
        appId="1088597931155576"
        autoLoad
        callback={responseFacebook}
        render={renderProps => (
          <button onClick={renderProps.onClick}>Custom FB Button</button>
        )}
      />
    );
  };

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

  • onClick
  • isDisabled
  • isProcessing
  • isSdkLoaded

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, {useCallback} from 'react';
  import FacebookLogin from 'react-facebook-login-typed';

  const MyComponent = () => {
    const responseFacebook = useCallback(() => {
      console.log(response);
    }, []);

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

Server

  import React, {useCallback} from 'react';
  import FacebookLogin from 'react-facebook-login-typed';

  const MyComponent = () => {
    const responseFacebook = useCallback(() => {
      console.log(response);
    }, []);

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

Parameters

paramsvaluedefault value
appIdstringRequired
scopestringpublic_profile, email, user_birthday
fieldsstringname,email,picture
callbackfunctionresultFacebookLogin
returnScopesbooleanfalse
autoLoadbooleanfalse
xfbmlbooleanfalse
cookiebooleanfalse
redirectUristringwindow.location.href (mobile-only)
versionstring3.1
languagestringen_US
onClickfunctionInitial click on the component
isMobilebooleandetected via userAgent
disableMobileRedirectbooleanfalseset to true for popup authentication on mobile devices
isDisabledbooleanundefined
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'