react-twitter-login
React component for simple OAuth with Twitter
Last updated 4 days ago by alexandrtovmach .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install react-twitter-login 
SYNC missed versions from official npm registry.

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

Current Tags

  • 1.5.0                                ...           latest (4 days ago)

13 Versions

  • 1.5.0                                ...           4 days ago
  • 1.4.0                                ...           8 months ago
  • 1.3.0                                ...           a year ago
  • 1.2.3                                ...           a year ago
  • 1.2.2                                ...           a year ago
  • 1.2.1                                ...           a year ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.0.0                                ...           5 years ago
Maintainers (1)
Downloads
Total 1,047
Today 0
This Week 23
This Month 31
Last Day 0
Last Week 3
Last Month 16
Dependencies (1)
Dev Dependencies (28)
Dependents (1)

Copyright 2014 - 2021 © npmmirror.com |