Giter Club home page Giter Club logo

phone-number-formatter's Introduction

Phone Number Formatter

CodeFactor

An android library to format Kenya πŸ‡°πŸ‡ͺ ,πŸ‡ΊπŸ‡¬ , πŸ‡ΉπŸ‡Ώ Phone Number to international format.

Download

You can add the library to your project via gradle

Step 1: Add in your root build.gradle of your project

   allprojects {
       repositories {
           ...
           maven { url 'https://jitpack.io' }
       }
   }

Step 2: Add the dependency to your app gradle

   dependencies {
       ...
    implementation 'com.github.Ikami-Mercy:phone-number-formatter:{latest-version}'
    ...
   }

Usage

To use the library call it from your Fragment or activity.

    // Kotlin example

    // Initialize your phone number
    val phoneNumber = "0712345678"

    // Initialize the selected country(Kenya, Tanzania, Uganda)
    val country = "Kenya"

    // Check if your phone number is valid
    val valid = PhoneNumberFormatter.isValidPhoneNumber(phoneNumber, country)

    // Format your phone number
   val formattedNumber =PhoneNumberFormatter.formatPhoneNumber(phoneNumber, country)
    // Java example

    // Initialize your phone number
    String phoneNumber = "0712345678"

 // Initialize the selected country(Kenya, Tanzania, Uganda)
    String country = "Kenya"

    // Check if your phone number is valid
    Boolean valid = PhoneNumberFormatter.isValidPhoneNumber(phoneNumber, country)

    // Format your phone number
   String formattedNumber =PhoneNumberFormatter.formatPhoneNumber(phoneNumber, country)

Screenshots

License

MIT License

Copyright (c) 2019 Mercy Ikami

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

phone-number-formatter's People

Contributors

ikami-mercy avatar ikamimercy avatar

Stargazers

Mfuon Leonard avatar  avatar

Watchers

James Cloos avatar  avatar

phone-number-formatter's Issues

UndocumentedPublicClass - [PhoneNumberFormatter] at /src/phonenumberformatterLibrary/src/main/java/com/ikami/phonenumberformatterlibrary/PhoneNumberFormatter.kt:5:1

Codacy detected an issue:

Message: UndocumentedPublicClass - [PhoneNumberFormatter] at /src/phonenumberformatterLibrary/src/main/java/com/ikami/phonenumberformatterlibrary/PhoneNumberFormatter.kt:5:1

Currently on:

UndocumentedPublicFunction - [useAppContext] at /src/phonenumberformatterLibrary/src/androidTest/java/com/ikami/phonenumberformatterlibrary/ExampleInstrumentedTest.kt:18:5

Codacy detected an issue:

Message: UndocumentedPublicFunction - [useAppContext] at /src/phonenumberformatterLibrary/src/androidTest/java/com/ikami/phonenumberformatterlibrary/ExampleInstrumentedTest.kt:18:5

Currently on:

UndocumentedPublicFunction - [addition_isCorrect] at /src/phonenumberformatterLibrary/src/test/java/com/ikami/phonenumberformatterlibrary/ExampleUnitTest.kt:13:5

Codacy detected an issue:

Message: UndocumentedPublicFunction - [addition_isCorrect] at /src/phonenumberformatterLibrary/src/test/java/com/ikami/phonenumberformatterlibrary/ExampleUnitTest.kt:13:5

Currently on:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.