@okteto/react-oauth2-login
TypeScript icon, indicating that this package has built-in type declarations

1.1.2 • Public • Published

React OAuth2 Login

React component for OAuth2 login.

Installation

yarn add @okteto/react-oauth2-login

or

npm install @okteto/react-oauth2-login

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import LoginOAuth2 from 'react-oauth2-login';

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

ReactDOM.render(
  <LoginOAuth2
    clientId="xxXXxxXXxxxxxXXXXx"
    authorizeUri="https://example.com/oauth2/authorize"
    onSuccess={onSuccess}
    onFailure={onFailure}
  />,
  document.getElementById('example')
);

Props

authorizeUri

{string} required

Authorize Uri for the OAuth2 application.

clientId

{string} required

Client ID for the OAuth2 application.

redirectUri

{string}

Registered redirect URI for GitHub OAuth application.

scope

{string}

responseType

{string}

Indicate response type returned as a pair in the fragment identifier of the URI (#) to which the user is redirected after completing the authorization process.

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.

state

{string}

Pass state value as a parameter of the redirect URI.

params

{string}

Extra params to pass to the authorize URI.

Development

$ yarn start

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

This component was inspired by https://github.com/checkr/react-github-login

Package Sidebar

Install

npm i @okteto/react-oauth2-login

Weekly Downloads

570

Version

1.1.2

License

MIT

Unpacked Size

27.9 kB

Total Files

21

Last publish

Collaborators

  • rlamana
  • rberrelleza2