PasscodeView is an Android Library to easily and securely authenticate the user with the PIN code or using the fingerprint scanner.
-
Secure authentication is the key factor in many application (e.g. financial applications). Many application uses PIN-based authentication.
-
But Android System doesn't provide any easy to set the view for PIN-based authentication which can tightly integrate and take advantage of fingerprint API introduced in newer versions of android. This limitation led me to work on this project.
-
With the �use of PasscodeView you can easily integrate PIN & Fingerprint based authentication in your application.
This library provide easy and secure PIN authentication view, which
- provides access to built-in fingerprint-based authentication. This handles all the complexities of integrating the fingerprint API with your application.
- provide error feedback when PIN entered is wrong.
- is highly customizable. So that you can match it with your application them. It provides you control over,
Authentication using PIN/Fingerprint
Success | Fail | Fingerprint Success | Fingerprint Fail |
---|---|---|---|
![]() |
![]() |
![]() |
![]() |
Localized Texts
English | Hindi |
---|---|
![]() |
![]() |
Different Key Shape
Rectangle | Circle | Square |
---|---|---|
![]() |
![]() |
![]() |
Here is the link of the demo application. 👉 Demo
-
- Add below lines to
app/build.gradle
file of your project.
dependencies { compile 'com.kevalpatel2106:passcodeview:1.1' }
- To integrate using maven visit this page.
- Add below lines to
-
<com.kevalpatel.passcodeview.PinView android:id="@+id/pin_view" android:layout_width="match_parent" android:layout_height="match_parent" android:layout_below="@id/imageView" app:dividerColor="@color/colorPrimaryDark" app:fingerprintDefaultText="Scan your finger to unlock application" app:fingerprintEnable="true" app:fingerprintTextColor="@color/colorAccent" app:fingerprintTextSize="@dimen/finger_print_text_size" app:titleTextColor="@android:color/white"/>
-
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //.... //... PinView pinView = (PinView) findViewById(R.id.pin_view); pinView.setCorrectPin(new int[]{1, 2, 3, 4}); //... }
-
- There are three built in key shapes. You can also generate your own key by extending
Key
class.- Round key
- Rectangle key
- Square key
- Here is the example for the round keys.
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //.... //... PinView pinView = (PinView) findViewById(R.id.pin_view); pinView.setCorrectPin(new int[]{1, 2, 3, 4}); //Build the desired key shape and pass the theme parameters. //REQUIRED pinView.setKey(new RoundKey.Builder(pinView) .setKeyPadding(R.dimen.key_padding) .setKeyStrokeColorResource(R.color.colorAccent) .setKeyStrokeWidth(R.dimen.key_stroke_width) .setKeyTextColorResource(R.color.colorAccent) .setKeyTextSize(R.dimen.key_text_size) .build()); //... }
- There are three built in key shapes. You can also generate your own key by extending
-
- There are two built in key shapes.
- Round indicator
- Dot indicator
- Here is the example for the round indicator. You can learn more about other indicators from here.
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //.... //... PinView pinView = (PinView) findViewById(R.id.pin_view); pinView.setCorrectPin(new int[]{1, 2, 3, 4}); pinView.setKey(...); //Build the desired indicator shape and pass the theme attributes. //REQUIRED pinView.setIndicator(new CircleIndicator.Builder(pinView) .setIndicatorRadius(R.dimen.indicator_radius) .setIndicatorFilledColorResource(R.color.colorAccent) .setIndicatorStrokeColorResource(R.color.colorAccent) .setIndicatorStrokeWidth(R.dimen.indicator_stroke_width) .build()); //... }
- There are two built in key shapes.
-
- Set the texts to display on different keys. This is optional step. If you don't set the key names, by default
PINView
will display English locale digits. - If you want to learn more about key name localization visit here.
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //.... //... PinView pinView = (PinView) findViewById(R.id.pin_view); pinView.setCorrectPin(new int[]{1, 2, 3, 4}); pinView.setKey(...); pinView.setIndicator(...); //Set the name of the keys based on your locale. //OPTIONAL. If not passed key names will be displayed based on english locale. pinView.setKeyNames(new KeyNamesBuilder() .setKeyOne(this, R.string.key_1) .setKeyTwo(this, R.string.key_2) .setKeyThree(this, R.string.key_3) .setKeyFour(this, R.string.key_4) .setKeyFive(this, R.string.key_5) .setKeySix(this, R.string.key_6) .setKeySeven(this, R.string.key_7) .setKeyEight(this, R.string.key_8) .setKeyNine(this, R.string.key_9) .setKeyZero(this, R.string.key_0)); //... }
- Set the texts to display on different keys. This is optional step. If you don't set the key names, by default
-
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); //.... //... PinView pinView = (PinView) findViewById(R.id.pin_view); pinView.setCorrectPin(new int[]{1, 2, 3, 4}); pinView.setKey(...); //REQUIRED pinView.setIndicator(...); //REQUIRED pinView.setKeyNames(...) //OPTIONAL pinView.setAuthenticationListener(new AuthenticationListener() { @Override public void onAuthenticationSuccessful() { //User authenticated successfully. //Navigate to next screens. } @Override public void onAuthenticationFailed() { //Calls whenever authentication is failed or user is unauthorized. //Do something if you want to handle unauthorized user. } }); //... }
Visit our wiki page for more information.
- Check out contribution guidelines 👉CONTRIBUTING.md
- Create view for pattern based authentication. (Upcoming Release preview)
- Build more customisation parameters to provide granular control over the theme of the view.
Copyright 2017 Keval Patel
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.