Pattern Lock View

Forked from LabMobi/pattern-lock & l7naive/pattern-lock

Awesome pattern lock view for android written in kotlin.

Features

• easy to use
• beautiful built-in styles
• fully customizable
• tiny size around 35 KB

Preview

Usage

Gradle

Top level build file:

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

In your application build file:

implementation 'com.github.am3n:pattern-lock:NEWEST-VERSION'

XML

<com.itsxtt.patternlock.PatternLockView
    android:id="@+id/patternLockView"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"/>

Kotlin

patternLockView.setOnPatternListener(object : PatternLockView.OnPatternListener {
    override fun onStarted() {
        super.onStarted()
    }

    override fun onProgress(ids: ArrayList<Int>) {
        super.onProgress(ids)
    }

    override fun onComplete(ids: ArrayList<Int>): Boolean {
        /*
         * A return value required
         * if the pattern is not correct and you'd like change the pattern to error state, return false
         * otherwise return true
         */
        return isPatternCorrect()
    }
})

Java

patternLockView.setOnPatternListener(new PatternLockView.OnPatternListener() {
    @Override
    public void onStarted() {

    }

    @Override
    public void onProgress(ArrayList<Integer> ids) {

    }

    @Override
    public boolean onComplete(ArrayList<Integer> ids) {
        /*
         * A return value required
         * if the pattern is not correct and you'd like change the pattern to error state, return false
         * otherwise return true
         */
        return isPatternCorrect();
    }
});

Customization

Built-in Styles

preview

style="@style/PatternLockView.JDStyle"

preview

style="@style/PatternLockView.WithIndicator"

Custom Attributes

name	format	default value	description
plv_regularCellBackground	color|reference	null
plv_regularDotColor	color	#d8dbe9
plv_regularDotRadiusRatio	float	0.3
plv_selectedCellBackground	color|reference	null
plv_selectedDotColor	color	#587bf4
plv_selectedDotRadiusRatio	float	0.3
plv_errorCellBackground	color|reference	null
plv_errorDotColor	color	#ea4954
plv_errorDotRadiusRatio	float	0.3
plv_lineStyle	enum	common	two values: common, indicator
plv_lineWidth	dimension	2dp
plv_regularLineColor	color	#587bf4
plv_errorLineColor	color	#ea4954
plv_spacing	dimension	24dp
plv_rowCount	integer	3
plv_columnCount	integer	3
plv_errorDuration	integer	400	millisecond
plv_hitAreaPaddingRatio	float	0.2
plv_indicatorSizeRatio	float	0.2

Secure Mode

You can turn the secure mode on or off via call enableSecureMode() and disableSecureMode().

Change Log

1.1.0 (2024-01-12)

• Selecting the cells that the pattern jumps over

1.0.0 (2024-01-03)

• Add to jitpack.io repo

0.4.1 (2023-11-06)

• Add support for changing success dot and line color at runtime

0.4.0 (2023-10-04)

• Ignore touch events when PatternLockView is disabled

0.3.0 (2023-08-30)

• Start node indices from 1 instead of 0
• Add auto reset boolean flag to disable automatically resetting the pin
• Add getSelectedIds() function to get the currently selected node ids
• Add success color and mode. Only shown when auto reset flag is not set

0.2.0 (2021-10-08)

• Migrate to androidx
• Migrate to mavenCentral

0.1.0 (2018-05-31)

• First release

License

Copyright 2018 itsxtt
Copyright 2023 Mobi Lab

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.