react-login-form-kashif
v1.3.5
Published
This project is a **React component library** for building login and authentication screens. It includes ready-made components for: - Login forms - Authorization cards - Two-factor authentication (2FA) verification
Maintainers
Readme
1. What is this project?
This project is a React component library for building login and authentication screens. It includes ready-made components for:
- Login forms
- Authorization cards
- Two-factor authentication (2FA) verification
You can use these components in your own React projects to quickly add user authentication features.
2. Main Components in This Project
a. AuthorizationCard
- What it does:
Shows a card asking the user to authorize an app to access their account. - Props:
onAuthorize: A function that runs when the user clicks the "Authorize" button.appName: (optional) The name of the app asking for permission.
b. LoginForm
- What it does:
Shows a login form where users can enter their email and password. It can also show a Google login button, a "remember me" checkbox, and handle 2FA. - Props:
onLogin: Function called with the email and password when the user submits the form.onGoogleLogin: Function called when the user logs in with Google.onAuthorizeApp: Function called when the user authorizes the app.isLoading: Shows a loading spinner on the login button.googleClientId: The Google OAuth client ID.enableGoogleLogin: If true, shows the Google login button.appName: The name of the app.LoggedIn: If true, shows that the user is already logged in.visibility2FA: Controls if the 2FA step is shown.rememberLogin: Function called when the "Remember me" checkbox is clicked.
c. TwoFAVerification
- What it does:
Shows a form for entering a 6-digit code for two-factor authentication. - Props:
onVerify: Function called with the code when the user submits the form.onResend: (optional) Function called when the user wants to resend the code.onCantLogin: (optional) Function called when the user can’t log in.isVerifying: (optional) Shows a loading spinner on the button.
7. What are the functions for?
- onLogin: Runs when the user submits their email and password.
- onGoogleLogin: Runs when the user logs in with Google.
- onAuthorize / onAuthorizeApp: Runs when the user authorizes the app.
- rememberLogin: Runs when the user clicks "Remember me".
- onVerify: Runs when the user submits a 2FA code.
- onResend: Runs when the user asks to resend the 2FA code.
- onCantLogin: Runs when the user says they can’t log in.
