Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
anoop44 committed Feb 11, 2020
1 parent a7f54a5 commit e9c0ab1
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
77 changes: 77 additions & 0 deletions README.md
@@ -0,0 +1,77 @@
# AwesomeTextInputLayout [ ![Download](https://api.bintray.com/packages/anoop44/maven/awesome-textinput-layout/images/download.svg?version=1.0.0) ](https://bintray.com/anoop44/maven/awesome-textinput-layout/1.0.0/link) <a href="https://android-arsenal.com/api?level=16"><img alt="API" src="https://img.shields.io/badge/API-16%2B-brightgreen.svg?style=flat"/></a>

An EditText decorator inspired by the EditText fields in Add New Contact screen of Google's Contact App

### style1
![gif of AwesomeTextInputLayout](https://raw.githubusercontent.com/anoop44/AwesomeTextInputLayout/master/art/awesome-textinput-layout-demo.gif)



## Adding to project

### Gradle
Add below code to your **root** `build.gradle` file (if you have multiple modules and only one of them require `AwesomeNavigation`, add the `jcenter()` repository only in that module's `build.gradle`).
```gradle
allprojects {
repositories {
jcenter()
}
}
```
And add the following dependency code to your **module**'s `build.gradle` file.
```gradle
dependencies {
implementation "ss.anoop:awesome-textinput-layout:${latest-version}"
}
```
AwesomeTextInputLayout is added a the immediate parent of the `EditText` you want to decorate. Below is a simple example

## Usage
```xml
<ss.anoop.awesometextinputlayout.AwesomeTextInputLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
app:borderColor="#5300e8"
app:borderWidth="2dp"
app:cornerRadius="8dp"
android:padding="16dp">

<EditText
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:hint="Name" />

</ss.anoop.awesometextinputlayout.AwesomeTextInputLayout>
```
### Customization

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


| Property Name | Format | Description |
|------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| borderColor | color | It defines the color of the border |
| borderWidth | dimension | defines the width of border (border stroke width) |
| cornerRadius | dimension | defines corner radius of border |
| padding | dimension | use padding to adjust the space between border and EditText |
| animationDuration | integer | defines the time for the hint animation |

## Find this library useful? :heart:
Support it by joining __[stargazers](https://github.com/anoop44/AwesomeTextInputLayout/stargazers)__ for this repository. :star:

# License
```
Copyright 2020 anoop44 (Anoop)
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.
```
File renamed without changes

0 comments on commit e9c0ab1

Please sign in to comment.