Skip to content

SSE Auth React Github Login

NPM DownloadsNPM Downloadsnpm version

React component for GitHub login.

Usage

js
import React from 'react';
import ReactDOM from 'react-dom';
import GitHubLogin from '@sse-auth/github';

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

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

Props

clientId

{string} required

Client ID for GitHub OAuth application.

clientSecret

{string} required

Client Secret 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.

Released under the MIT License.