Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.18 KB

README.md

File metadata and controls

39 lines (28 loc) · 2.18 KB

react-phone-hooks

npm React types License Tests

This comprehensive toolkit features custom hooks and utility functions tailored for phone number formatting, parsing, and validation. It supports international standards, making it suitable for phone number processing applications across different countries and regions.

Usage

This library can be used to build a phone number input component with a country selector for React applications. As well as to parse the phone metadata, validate phone numbers, format raw phone numbers into a more readable format and the opposite. You can use the development to test and develop your own components.

import {getFormattedNumber, getMetadata, parsePhoneNumber, useMask} from "react-phone-hooks";

getFormattedNumber("440201111111"); // +44 (02) 011 11111
getMetadata("440201111111"); // ["gb", "United Kingdom", "44", "+44 (..) ... ....."]
parsePhoneNumber("+44 (02) 011 11111"); // {countryCode: 44, areaCode: "02", phoneNumber: "01111111", isoCode: "gb"}

const PhoneInput = (props) => {
    return <input {...useMask("+1 (...) ... ....")} {...props}/>
}

Contribute

Any contribution is welcome. Don't hesitate to open an issue or discussion if you have questions about your project's usage and integration. For ideas or suggestions, please open a pull request. Your name will shine on our contributors' list. Be proud of what you build!

License

Copyright (C) 2023 Artyom Vancyan. MIT