https://github.com/jlumbroso/react-github-login

:octocat: A React Component for GitHub Login
https://github.com/jlumbroso/react-github-login

github login react

Last synced: about 2 months ago
JSON representation

:octocat: A React Component for GitHub Login

• Host: GitHub
• URL: https://github.com/jlumbroso/react-github-login
• Owner: jlumbroso
• Created: 2016-11-26T17:26:01.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-04-14T10:49:55.000Z (over 2 years ago)
• Last Synced: 2024-04-15T08:08:44.763Z (5 months ago)
• Topics: github, login, react
• Language: JavaScript
• Homepage:
• Size: 78.1 KB
• Stars: 95
• Watchers: 3
• Forks: 49
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React GitHub Login

![NPM](https://img.shields.io/npm/v/react-github-login.svg?style=flat)

![CircleCI](https://circleci.com/gh/checkr/react-github-login.svg?style=shield&circle-token=493b950057f69e68ac8698a9ee189b2132a296e4)

React component for [GitHub login](https://developer.github.com/v3/oauth/).

## Usage

```js

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(

  ,

  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

```sh

$ npm start

```

Webpack development server starts at [http://localhost:8080](http://localhost:8080), loading [example/index.html](github.com/checkr/react-facebook-login/tree/master/example/index.html).