skylab-package
v1.11.2
Published
Downloads
30
Readme
Diamondloginpage
Diamondloginpage is a React-based login component designed for easy integration and customization. It features "Remember Me" functionality, password encryption, and an integrated password reset option, all styled with Tailwind CSS.
Features
- Encrypted "Remember Me" functionality.
- Custom branding with logo and side images.
- Built-in support for password resets.
- Responsive design for mobile-friendly usage.
Installation
To install the package, use npm:
npm install diamondloginpage
## Usage
Here’s an example of how to use the component:
import { Login } from 'diamondloginpage';
const App = () => {
return (
<Login
apiLoginEndpoint="/api/login"
apiForgotPasswordEndpoint="/api/forgot-password"
onLoginSuccess={(response) => console.log(response)}
logo="path/to/logo.png"
sideImage="path/to/side-image.png"
/>
);
};
| Prop | Type | Required | Description |
|-----------------------------|----------|----------|-----------------------------------------------------------------------------------------------------|
| `apiLoginEndpoint` | string | Yes | The API endpoint for login. |
| ... | ... | ... | ... |
For questions or feedback, reach out at [[email protected]].