react-twitter-login

    1.4.0 • Public • Published

    react-twitter-login

    npm npm bundle size npm

    React component for a simple OAuth login with Twitter. This package NOT FOR PRODUCTION, because it's require to keep CONSUMER_KEY and CONSUMER_SECRET on client side, which are huge security risk. Use this package for MVP or quick prototype only. If you looking for some production solution, please use server side authorization like passport-twitter.

    DEMO HERE

    SECURITY NOTE: This package using third-party proxy cors.bridged.cc, to resolve CORS policy protection on requests from your custom domain to api.twitter.com. If it's not work for you for some security concerns, we recommend to use server side authorization like passport-twitter or other.

    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.

      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";
      
      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

    Install

    npm i react-twitter-login

    DownloadsWeekly Downloads

    1,613

    Version

    1.4.0

    License

    MIT

    Unpacked Size

    46 kB

    Total Files

    17

    Last publish

    Collaborators

    • alexandrtovmach