0.2.1 • Published 2 years ago

@ansuzdev/sso-ui v0.2.1

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Ansuz SSO UI

Install:

// npm
npm i -S @ansuzdev/sso-ui

// yarn
yarn add @ansuzdev/sso-ui

This package defines 3 forms for Ansuz SSO: login, register and forgot password those are used in React app.

Note: appId from SSO is required to initialize each form.

Login form

import {LoginForm} from "@ansuzdev/sso-ui";

<LoginForm appId="[ENTER_APP_ID]" />

All properties:

NameTypeRequiredDefaultDescription
appIdstringxSSO app ID
showRegisterbooleantrueShow register link
showForgotPasswordbooleantrueShow forgot password link
onLoginfuncnullOn login callback
onRegisterfuncnullOn register callback
onForgotPasswordfuncnullOn forgot password callback

Register form

Beside appId, you need to put baseUrl (where to call register API) to setup register form.

import {RegisterForm} from "@ansuzdev/sso-ui";

<RegisterForm
  baseUrl="[REGISTER_API_URL]"
  appId="[ENTER_APP_ID]"
/>

All properties:

NameTypeRequiredDefaultDescription
appIdstringxSSO app ID
baseUrlstringxURL to register api
showLoginbooleantrueShow login link
showForgotPasswordbooleantrueShow forgot password link
onLoginfuncnullOn login callback
onRegisterfuncnullOn register callback
onForgotPasswordfuncnullOn forgot password callback

Forgot password form

import {ForgotPasswordForm} from "@ansuzdev/sso-ui";

<ForgotPasswordForm appId="[ENTER_APP_ID]" />

All properties:

NameTypeRequiredDefaultDescription
appIdstringxSSO app ID
showLoginbooleantrueShow login link
showRegisterbooleantrueShow register link
onLoginfuncnullOn login callback
onRegisterfuncnullOn register callback
onForgotPasswordfuncnullOn forgot password callback