akaragiannis-password-form-validation
v1.1.0
Published
Welcome to the Password Validation Form Library for React! This library offers a straightforward password entry component, designed specifically to meet the requirements of an assessment project.
Downloads
1
Readme
React Password Validation Form Library
Welcome to the Password Validation Form Library for React! This library offers a straightforward password entry component, designed specifically to meet the requirements of an assessment project.
Why Use This Library?
In response to the needs of an assessment project, I developed this library to fulfill the following password entry criteria using React:
- Two input fields for user entry (ensuring both inputs match)
- Minimum password length of 6 characters
- At least 1 uppercase character
- At least 1 lowercase character
- At least 1 number
- At least 1 special character (!@#$%^&*()_-+={[}]|:;"'<,>.)
- Submit button triggering validation and presenting success or reasons for password entry failure
Task:
- Implement a password entry library in React.
- Ensure validation based on specified criteria.
- Display success or failure messages.
Supports
React: 16.7.0+ Typescript: 5.0.0+
Works both on Javascript & Typescript React projects.
Requirements
Prerequisites: 'react' & 'react-dom'
Installation
To integrate this library into your project, follow these simple steps:
npm install akaragiannis-password-form-validation
Usage
Import the component from the npm package
import { PasswordForm } from "akaragiannis-password-form-validation";
In your JSX/TSX, include
<PasswordForm />
This component does not accept any props as it is designed to be simple and easy to use.
Examples
Feel free to view in CodeSandBox or
- Clone the repository.
- Install dependencies using
npm install
. - Run
npm run build --workspaces
. - Start the development server using
npm run dev -w examples/simple-example-typescript
. - Visit http://localhost:5173/ in your preferred browser.
Releasing
This repository adheres to semantic versioning, and the release process is automated through 'semantic-release' & github actions. Angular conventional commit messages are required.
Once a new commit is pushed into the main branch, a github action is dispatched that tests, builds, creates a new versioned release and publishes it to both github & npm while attaching all patch notes.
Missing Features
Some features are still in progress:
- Not in scope but would be beneficial: Trigger a callback function passed through props when validation fails or passes with proper validation state, message, and data.
- PR workflow checks (commit linting, running tests, prettier, lint, etc)
- Github branch protection
- Testing
- Contributing Guide