dondoko-susumu/react-twitter-login

Twitter OAuth with React

react-twitter-login

React component for a simple OAuth login with Twitter.

DEMO HERE

🚀 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

Property	Type	Default	Description
authCallback	function	required	Callback function which takes two arguments (error, authData)
consumerKey	string	required	Consumer API Key of your Twitter developer app (not Access Token)
consumerSecret	string	required	Consumer API Secret of your Twitter developer app (not Access Token Secret)
callbackUrl	string	required	Whitelisted callback URL of your Twitter app
buttonTheme	enum("light", "light_short", "dark", "dark_short")	"light"	Button style theme, that based on Twitter Brand Design
className	string	""	Custom class name
children	React.Component	""	Provide any component as a "children" prop to use custom button

📝 License

MIT