README.md

material-ui-phone-field

Highly customizable typescript-based phone field component with auto-formatting built for Material UI. Based on react-phone-input-2 package.

Getting Started

To get started, clone the project and run

yarn install

Then, run Storybook

yarn storybook

Make changes to files and see those changes live in Storybook.

Contributing

Project still in its early stage of development. Feel free to contribute.

What needs to be done:

• [] Convert PhoneField Class into Functional Component
• [] Improve props/state (refactor if needed)
• [] Improve codebase
• [] Make components customizable (input adornment, dropdown... etc)
• [] Add unit/integration tests
• [] Deploy NPM package
• [] Add documentation
• [] Add CI/CD

License

Based on react-phone-input-2