https://github.com/patw0929/react-intl-tel-input
Rewrite International Telephone Input in React.js. (Looking for maintainers, and PRs & contributors are also welcomed!)
https://github.com/patw0929/react-intl-tel-input
component flags input international-telephone phonenumber react react-component telephone
Last synced: 5 months ago
JSON representation
Rewrite International Telephone Input in React.js. (Looking for maintainers, and PRs & contributors are also welcomed!)
- Host: GitHub
- URL: https://github.com/patw0929/react-intl-tel-input
- Owner: patw0929
- License: mit
- Created: 2015-06-19T17:02:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T05:21:01.000Z (over 1 year ago)
- Last Synced: 2025-05-12T04:36:42.385Z (5 months ago)
- Topics: component, flags, input, international-telephone, phonenumber, react, react-component, telephone
- Language: JavaScript
- Homepage: https://patw0929.github.io/react-intl-tel-input/
- Size: 6.75 MB
- Stars: 285
- Watchers: 12
- Forks: 220
- Open Issues: 82
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# React-Intl-Tel-Input
[](http://makeapullrequest.com)
[](https://github.com/patw0929/react-intl-tel-input/actions/workflows/main.yml)
[](http://badge.fury.io/js/react-intl-tel-input)
[](https://coveralls.io/github/patw0929/react-intl-tel-input?branch=master)
[]()[](https://nodei.co/npm/react-intl-tel-input/)
Rewrite [International Telephone Input](https://github.com/jackocnr/intl-tel-input) in React.js.
## Collaborators Wanted!
Due to the long commuting time, I do not have much time to maintain this project often. 😣
So if anybody else is willing to take on the work of bug fixes, integrating pull requests, etc,
please let me know. 🙌I hope we can maintain the project together, and make this project better! 💪
## Demo & Examples
Live demo: [patw0929.github.io/react-intl-tel-input](https://patw0929.github.io/react-intl-tel-input/)
To build the examples locally, run:
```bash
yarn
yarn website:start
```Then open [`localhost:3000`](http://localhost:3000) in a browser.
## Installation
```bash
yarn add react-intl-tel-input
```### TypeScript
`react-intl-tel-input` ships with official type declarations out of the box.
## Usage
```javascript
import IntlTelInput from 'react-intl-tel-input';
import 'react-intl-tel-input/dist/main.css';```
### Properties
Please see the [Demo Page](https://patw0929.github.io/react-intl-tel-input/)
## Development (`src` and the build process)
To build, watch and serve the examples (which will also watch the component source), run `yarn website:start`.
You can prepare a distribution build using `yarn build`.
## Contributing
Any kind of contribution including proposals, doc improvements, enhancements, bug fixes are always welcome.
To contribute to `react-intl-tel-input`, clone this repo locally and commit your code on a separate branch. Please write tests for your code, and run the linter before opening a pull-request:
```bash
yarn test # if you are enhancing the JavaScript modules
yarn test:ts # if you are enhancing the TypeScript type declarations
yarn lint
```Also, please let us know if you encounter any issue by filing an [issue](https://github.com/patw0929/react-intl-tel-input/issues).
## Inspired by
[International Telephone Input](https://github.com/jackocnr/intl-tel-input) - [@jackocnr](https://github.com/jackocnr)
## License
MIT
Copyright (c) 2015-2019 patw.