1.1.3 • Published 4 years ago

@tomdracz/react-twitter-login v1.1.3

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

react-twitter-login

npm npm bundle size npm

React component for a simple OAuth login with Twitter.

DEMO HERE

image

🚀 Get Started

Follow these steps to start using React Twitter Login:

  1. Installation

    # with npm
    npm i react-twitter-login
    
    # with yarn
    yarn add react-twitter-login
  2. Import and configure component.

    import React from "react";
    import TwitterLogin from "react-twitter-login";
    
    export default props => {
      const authHandler = (err, data) => {
        console.log(err, data);
      };
    
      return (
        <TwitterLogin
          authCallback={authHandler}
          consumerKey={CONSUMER_KEY}
          consumerSecret={CONSUMER_SECRET}
          callbackUrl={CALLBACK_URL}
        />
      );
    };
  3. Find more info about keys and Twitter developer apps in official docs.

📖 API

PropertyTypeDefaultDescription
authCallbackfunctionrequiredCallback function which takes two arguments (error, authData)
consumerKeystringrequiredConsumer API Key of your Twitter developer app (not Access Token)
consumerSecretstringrequiredConsumer API Secret of your Twitter developer app (not Access Token Secret)
callbackUrlstringrequiredWhitelisted callback URL of your Twitter app
buttonThemeenum("light", "light_short", "dark", "dark_short")"light"Button style theme, that based on Twitter Brand Design
classNamestring""Custom class name
childrenReact.Component""Provide any component as a "children" prop to use custom button

📝 License

MIT