react-twitter-login-button

🚀 Get Started

Follow these steps to start using React Twitter Login:

1. Installation

   # with npm
   npm i react-twitter-login-button
   
   # with yarn
   yarn add react-twitter-login-button

2. Import and configure component.

   This component should be rendered on route that match with one of whitelisted callback URLs of your Twitter app.

   import React from "react";
   import TwitterLogin from "react-twitter-login-button";
   
   export default (props) => {
     const authHandler = (err, data) => {
       console.log(err, data);
     };
   
     return (
       <TwitterLogin
         authCallback={authHandler}
         consumerKey={CONSUMER_KEY}
         consumerSecret={CONSUMER_SECRET}
       />
     );
   };

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