Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/l7naive/pattern-lock
Awesome pattern lock view for android written in kotlin.
https://github.com/l7naive/pattern-lock
android gesture-lock kotlin pattern-lock
Last synced: 9 days ago
JSON representation
Awesome pattern lock view for android written in kotlin.
- Host: GitHub
- URL: https://github.com/l7naive/pattern-lock
- Owner: l7naive
- License: other
- Created: 2018-05-16T07:36:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T07:28:39.000Z (about 1 year ago)
- Last Synced: 2024-08-01T19:55:21.703Z (4 months ago)
- Topics: android, gesture-lock, kotlin, pattern-lock
- Language: Kotlin
- Homepage:
- Size: 2.59 MB
- Stars: 148
- Watchers: 4
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - l7naive/pattern-lock - Awesome pattern lock view for android written in kotlin. (Kotlin)
README
# Pattern Lock View
[](https://android-arsenal.com/details/1/6988)
Awesome pattern lock view for android written in kotlin.
[demo](https://github.com/itsxtt/pattern-lock/tree/master/apk)
## Features
* easy to use
* beautiful built-in styles
* fully customizable
* tiny size around 35 KB
## Preview
## Usage
### Gradle
Top level build file:
``` gradle
allprojects {
repositories {
mavenCentral()
}
}
```
In your application build file:
``` gradle
implementation 'io.github.itsxtt:pattern-lock:0.2.0'
```
### XML
``` xml
```
### Kotlin
``` Kotlin
patternLockView.setOnPatternListener(object : PatternLockView.OnPatternListener {
override fun onStarted() {
super.onStarted()
}
override fun onProgress(ids: ArrayList) {
super.onProgress(ids)
}
override fun onComplete(ids: ArrayList): 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
``` Java
patternLockView.setOnPatternListener(new PatternLockView.OnPatternListener() {
@Override
public void onStarted() {
}
@Override
public void onProgress(ArrayList ids) {
}
@Override
public boolean onComplete(ArrayList 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](https://github.com/itsxtt/pattern-lock/blob/master/screenshots/jdstyle.gif)
```
style="@style/PatternLockView.JDStyle"
```
[preview](https://github.com/itsxtt/pattern-lock/blob/master/screenshots/indicator.gif)
```
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](https://github.com/itsxtt/pattern-lock/blob/master/screenshots/default.gif), [indicator](https://github.com/itsxtt/pattern-lock/blob/master/screenshots/indicator.gif)
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
### 0.2.0 (2021-10-08)
* migrate to androidx
* migrate to mavenCentral
### 0.1.0 (2018-05-31)
* first release
## License
Copyright 2018 itsxtt
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.