thushcapone / material_phone_widget

A material phone widget compatible with country picker + Data Binding and AAC friendly

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to Material Phone Widget!

MaterialPhoneWidget is your phone widget that is Android Architecture Component friendly, compatible with Data-Binding and two ways binding

Demo

gif of MaterialPhoneWidget

Adding to project

Gradle

Add below code to your root build.gradle file (if you have multiple modules and only one of them require MaterialPhoneWidget, add the jitpack url only in that module's build.gradle).

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

And add the following dependency code to your module's build.gradle file.

dependencies {  
 implementation "com.github.thushcapone:material_phone_widget:${latest-version}"
}  

Usage

<com.thushcapone.material_phone_widget.PhoneWidget    
  android:layout_width="match_parent"    
  android:layout_height="wrap_content"    
  android:layout_gravity="center"    
  app:hint="Enter your phone number"    
  app:defaultCountry="US"    
  />  

Usage with MVVM + DataBinding

<com.thushcapone.material_phone_widget.PhoneWidget    
  android:id="@+id/phone_number_login"    
  android:layout_width="match_parent"    
  android:layout_height="wrap_content"    
  android:layout_gravity="center"    
  app:hint="Enter your phone number"  
  bind:phoneNumber="@={viewModel.phoneNumber}"    
  bind:onValidPhoneListener="@{viewModel::onValidPhoneTyped}"    
  bind:countryCodeListener="@{viewModel::onCountryCodeSelected}"    
  />  

Customization

Table below describes the properties available to customize the AwesomeNavigation. Some options are applicable to only certain styles

Property Name Format Description
hint reference Set the string resource used as the default hint
defaultCountry string Set the default country code to show, expecting the country short code (E.g. 'US', 'FR')
phoneNumber binding-value Will receive the value of the phoneNumber typed
validPhoneListener binding-function Will be called when a valid phone has been typed and passes the phone typed validPhone
countryCodeListener binding-function Will be called when the country picker's value changed and passes the country code selected countryCode

License

Copyright (c) 2019. T.C.  
  
Licensed under the Apache License, Version 2.0 (the "License");  
you may not use this file except in compliance with the License.  
You may obtain a copy of the License at  
  
 http://www.apache.org/licenses/LICENSE-2.0  
Unless required by applicable law or agreed to in writing, software  
distributed under the License is distributed on an "AS IS" BASIS,  
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
See the License for the specific language governing permissions and  
limitations under the License. ```

About

A material phone widget compatible with country picker + Data Binding and AAC friendly


Languages

Language:Kotlin 92.2%Language:Java 7.8%