react-github-login

A React Component for GitHub Login

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-github-login
91171.0.35 years ago6 years agoMinified + gzip package size for react-github-login in KB

Readme

React GitHub Login
NPM CircleCI
React component for GitHub login.

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import GitHubLogin from 'react-github-login';

const onSuccess = response => console.log(response);
const onFailure = response => console.error(response);

ReactDOM.render(
  <GitHubLogin clientId="ac56fad434a3a3c1561e"
    onSuccess={onSuccess}
    onFailure={onFailure}/>,
  document.getElementById('example')
);

Props

clientId

{string} required
Client ID for GitHub OAuth application.

redirectUri

{string}
Registered redirect URI for GitHub OAuth application.

scope

{string}
Scope for GitHub OAuth application. Defaults to user:email.

className

{string}
CSS class for the login button.

buttonText

{string}
Text content for the login button.

onRequest

{function}
Callback for every request.

onSuccess

{function}
Callback for successful login. An object will be passed as an argument to the callback, e.g. { "code": "..." }.

onFailure

{function}
Callback for errors raised during login.

Development

$ npm start

Webpack development server starts at http://localhost:8080, loading example/index.html.