Files
VercodeEditText/README.md
YangJing96 82ad9c34c5 Action:alter
Description:更改readme
2017-06-25 18:22:05 +08:00

91 lines
4.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<img src="/img/VercodeEditTex.png" width="600px"/>
## Introduction
An android Verification code EditText.
一个安卓验证码输入框控件。([中文版入口](README-CN.md))
[![Platform](https://img.shields.io/badge/platform-android-green.svg)](http://developer.android.com/index.html)
<img src="https://img.shields.io/badge/license-Apache 2.0-green.svg?style=flat">
[![API](https://img.shields.io/badge/API-12%2B-green.svg?style=flat)](https://android-arsenal.com/api?level=11)
## Demo
Prevent input overflow.
<img src="/img/demo.gif" width="280px"/>
## Features
- [x] **Extends EditText,it can be used as EditText**
- [x] **Prevent input overflow**
- [x] **Custom validation code length**
- [x] **Provide input value listener**
- [x] **Layout height is auto adjust**
- [x] **Attributes can be configured for customization**
## Version
name|SlideMenuLayout
---|---
latest|![Download](https://api.bintray.com/packages/jkb/maven/vercodeedittext/images/download.svg)
## Configure
#### Maven
```xml
<dependency>
<groupId>com.justkiddingbaby</groupId>
<artifactId>vercodeedittext</artifactId>
<version>the latest version</version>
<type>pom</type>
</dependency>
```
#### JCenter
First. add to project build.gradle
```gradle
repositories {
jcenter()
}
```
Second. add to module build.gradle
```gradle
compile 'com.justkiddingbaby:vercodeedittext:the latest version'
```
## Attributes instruction
attribute|instruction|value
---|---|---
|[figures](/vcedittext-lib/src/main/res/values/attrs.xml)|the verification code length|integer|
|[verCodeMargin](/vcedittext-lib/src/main/res/values/attrs.xml)|the padding for each verification code number|dimension|
|[bottomLineSelectedColor](/vcedittext-lib/src/main/res/values/attrs.xml)|the color of bottom line is select status|reference|
|[bottomLineNormalColor](/vcedittext-lib/src/main/res/values/attrs.xml)|the color of bottom line is normal status|reference|
|[bottomLineHeight](/vcedittext-lib/src/main/res/values/attrs.xml)|the height of bottom line|dimension|
|[selectedBackgroundColor](/vcedittext-lib/src/main/res/values/attrs.xml)|the background color of verification code is select status|reference|
## Function instruction
return|function name|instruction
---|---|---
|void|[setFigures(int figures)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|set the verification code length|
|void|[setVerCodeMargin(int margin)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|set the padding for each verification code number|
|void|[setBottomSelectedColor(int bottomSelectedColor)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|set the color of bottom line is select status|
|void|[setBottomNormalColor(int bottomNormalColor)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|set the color of bottom line is normal status|
|void|[setSelectedBackgroundColor(int selectedBackground)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|set the background color of verification code is select status|
|void|[setBottomLineHeight(int bottomLineHeight)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|set the height of bottom line|
|void|[setOnVerificationCodeChangedListener(OnVerificationCodeChangedListener listener)](/vcedittext-lib/src/main/java/com/jkb/vcedittext/VerificationAction.java)|add the listener when verification value is changing|
## Usage
#### use in the layout
```xml
<com.jkb.vcedittext.VerificationCodeEditText
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:inputType="number"
android:text="123"
android:textColor="@color/colorPrimary"
android:textSize="40sp"
app:bottomLineHeight="2dp"
app:bottomLineNormalColor="@color/gravy_light"
app:bottomLineSelectedColor="@color/colorAccent"
app:figures="4"
app:selectedBackgroundColor="@color/colorPrimary_alpha33"
app:verCodeMargin="10dp" />
```
## Release history
#### v1.0.0(2017/6/12)
1、release VercodeEditTextPrevent input overflow.
2、Encapsulation demo.