React Pincode is a published NPM module that can be integrated inside any ReactJS application. It is used to extract Area, City, District, and State information as soon as the user enters valid Pin-Code. On entering a valid Pin-Code, a GET request is made
npm install react-pincodeReact Pincode is a published NPM module that can be integrated inside any ReactJS application. It is used to extract Area, City, District, and State information as soon as the user enters valid Pin-Code. On entering a valid Pin-Code, a GET request is made to the Indian Postal Service API and the useful information is extracted and results are displayed in the respective fields. If an invalid Pincode is entered an error is thrown which can be customized by a user using a specific prop.
- About
- Prerequisites
- Note
- Working
- JS
- Playground
- Pincode props
- Example
- JS
- Development and Testing
- Contributing
- Development Guidelines
- Owner
The four input fields are wrapped inside an Whenever the wrong Pincode is entered red border appears on the pin code input field and on entering a right pin code, city, district and state input fields get automatically filled with correct data This will only work for Indian Pincodes. `` ` function App() { Find Codepen Implementation of the module here 1. Props for changing CSS properties | Name | Description | 2. Props for changing error message. By deafult, - For an Invalid Pincode - "Invalid PIN Code" | Name | Description | export default class Example extends Component { 1. Set-up the React-Pincode module by dowloading its dependencies, using Please read Contributing Guidelines for information on how to contribute to React-Pincode. 1. Write clean and readable code with proper formatting. element and each input field is also wrapped inside . So that a user can style it according to the need in the project.$3
Working
js`
import Pincode from 'react-pincode';$3
js
import React, { useState, useEffect } from 'react';
import Pincode from 'react-pincode';
const [pincodeData, setPincodeData] = useState('');
return (
lengthError="check length"
getData={(data) => setPincodeData(data)}
/>
);
}
``$3
Pincode Props
| ----------------- | --------------------------------------------------- |
| Container | Container which wraps all the three Input Field |
| pincodeContainer | Container which wraps pincode Input Field |
| cityContainer | Container which wraps City Input Field |
| districtContainer | Container which wraps District Input Field |
| stateContainer | Container which wraps State Input Field |
| pincodeInput | Props for styling pincode input field |
| cityInput | Props for styling city input field |
| stateInput | Props for styling state input field |
| showArea | Props for displaying Area input (default: true) |
| showState | Props for displaying State input (default: true) |
| showDistrict | Props for displaying District input (default: true) |
| showCity | Props for displaying City input (default: true) |
- If Pincode length is not valid - "ZIP code must be of 6 digits"
| ------------ | ------------------------------------------ |
| invalidError | Props for changing invalid error message. |
| lenghtError | Props for changing invalid length message. |Example
$3
js`
import React, { Component } from 'react';
import Pincode from "react-pincode";
render() {
return (
// This will set the length of city input field to 200px. You can play with rest of the props to style it according to your need.
)
}
}
export default Example;npm install$3
command.npm run build
2. Build the module using npm link
3. Link the module for testing using command.test-server
4. Change your directory to directory, using cd test-servernpm install
5. Install the dependecies using npm link react-pincode
6. Now run npm start
7. Congratulations! You have set-up the test server for react-pincode.
Now just run from test-server directory to launch the test-server.npm run build`
8. You don't need to stop this server, the changes made in the module will be reflected automatically each time you build them using
9. To watch a video on installation (Click on the thumbnail):
Contributing
Development Guidelines
2. Create a branch and push your code in the branch.
3. Please follow PR template to create one.
4. Please read our Code of Conduct .Owner