Skip to content

Commit 9babee3

Browse files
authored
Update README.md
1 parent 38016a6 commit 9babee3

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

+26-13
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ allprojects {
2525
```
2626
```groovy
2727
dependencies {
28-
compile 'com.github.HITGIF:TextFieldBoxes:-SNAPSHOT'
28+
compile 'com.github.HITGIF:TextFieldBoxes:v1.0.0'
2929
}
3030
```
3131

@@ -42,7 +42,7 @@ dependencies {
4242
<dependency>
4343
<groupId>com.github.HITGIF</groupId>
4444
<artifactId>TextFieldBoxes</artifactId>
45-
<version>-SNAPSHOT</version>
45+
<version>v1.0.0</version>
4646
</dependency>
4747
```
4848

@@ -51,7 +51,7 @@ dependencies {
5151
resolvers += "jitpack" at "https://jitpack.io"
5252
```
5353
```scala
54-
libraryDependencies += "com.github.HITGIF" % "TextFieldBoxes" % "-SNAPSHOT"
54+
libraryDependencies += "com.github.HITGIF" % "TextFieldBoxes" % "v1.0.0"
5555
```
5656

5757

@@ -60,7 +60,7 @@ libraryDependencies += "com.github.HITGIF" % "TextFieldBoxes" % "-SNAPSHOT"
6060
:repositories [["jitpack" "https://jitpack.io"]]
6161
```
6262
```scala
63-
:dependencies [[com.github.hitgif/textfieldboxes "-SNAPSHOT"]]
63+
:dependencies [[com.github.hitgif/textfieldboxes "v1.0.0"]]
6464
```
6565

6666
@@ -167,7 +167,7 @@ app:helperTextColor="#795548" <!--Brown-->
167167

168168
#### 8. Customize EditText
169169

170-
If you want to customize the `EditText` in the `TextFieldBoxes` (which is a inherited `FrameLayout` that contains a `EditText` for input), use the `getEditText()` methond in Java and do whatever you like (e.g. `setOnKeyListener()`, `addTextChangedListener`)
170+
If you want to customize the `EditText` in the `TextFieldBoxes` (which is a inherited `FrameLayout` that contains a `EditText` for input), use the `getEditText()` methond in Java and do whatever you like (e.g. `setOnKeyListener()`, `addTextChangedListener()`)
171171

172172
```java
173173
final TextFieldBoxes textFieldBoxes = findViewById(R.id.text_field_boxes);
@@ -193,33 +193,46 @@ textFieldBoxes.getEditText().addTextChangedListener(new TextWatcher() {
193193
![](/images/edittext.gif)
194194

195195
196-
## Documentation
197-
### All Attributes
196+
## All Attributes
198197

199-
`app:enabled` Whether the text field is enabled. `True` by default.
198+
#### Texts
200199

201200
`app:text` EditText text.
202201

203202
`app:hint` Hint text at the top.
204203

205204
`app:helperText` Helper text at the bottom.
206205

207-
`app:singleLine` Whether the EditText is single-lined. `False` by default.
206+
#### Colors
208207

209-
`app:maxLines` The number of maximum lines allowed in the text field. `Integer.MAX_VALUE` by default.
208+
`app:helperTextColor` Helper text color.
209+
210+
`app:errorColor` The color that is used to indicate error (e.g. exceeding max characters, `setError()`).
211+
212+
`app:primaryColor` The color for the underline and the hint text. Current theme `Primary Color` by default.
213+
214+
#### Characters counter
210215

211216
`app:maxCharacters` Max characters count limit. `0` means no limit. `0` by default.
212217

213218
`app:minCharacters` Min characters count limit. `0` means no limit. `0` by default.
214219

215-
`app:helperTextColor` Helper text color.
220+
#### Others
216221

217-
`app:errorColor` The color that is used to indicate error (e.g. exceeding max characters, `setError()`).
222+
`app:enabled` Whether the text field is enabled. `True` by default.
218223

219-
`app:primaryColor` The color for the underline and the hint text. Current theme `Primary Color` by default.
224+
`app:singleLine` Whether the EditText is single-lined. `False` by default.
225+
226+
`app:maxLines` The number of maximum lines allowed in the text field. `Integer.MAX_VALUE` by default.
220227

221228
`app:hasFocus`Whether the EditText is having the focus. `False` by default.
222229

230+
231+
## Todo List
232+
- Prefix & Suffix
233+
- Icon signifier
234+
- Dark theme
235+
223236
224237
## License
225238

0 commit comments

Comments
 (0)