Skip to content

Commit 276fe66

Browse files
committed
dev: Status/description changes
1 parent 9f3a6e2 commit 276fe66

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# StepViewAndroid
2-
An android library written in kotlin to display steps (without any max-min limits) along with the descriptions. It also supports some really cool features.
2+
An android library written in kotlin to display steps (without any max-min limits) along with the status/description. It also supports some really cool features.
33

44
## Usage
55

@@ -17,10 +17,10 @@ An android library written in kotlin to display steps (without any max-min limit
1717
<params.com.statusView.StatusViewScroller
1818
android:layout_width="wrap_content"
1919
android:layout_height="wrap_content"
20-
app:statusCount="5"
20+
app:stepCount="5"
2121
app:currentCount="4"
2222
app:drawCount="true"
23-
android:entries="@array/statuses"
23+
android:entries="@array/status"
2424
app:circleColorType="fillStroke"
2525
app:lineGap="5dp"
2626
app:lineWidth="3dp"
@@ -47,31 +47,31 @@ An android library written in kotlin to display steps (without any max-min limit
4747
* Set different drawables for completed, current & incomplete states.
4848

4949
```XML
50-
app:currentStatusZoom="0.5"
50+
app:currentStepZoom="0.5"
5151
app:complete_drawable="@drawable/ic_satisfied_black_24dp"
5252
app:current_drawable="@drawable/ic_dissatisfied_black_24dp"
5353
app:incomplete_drawable="@drawable/ic_very_dissatisfied_black_24dp"
5454
```
5555

56-
### Step description customisations
56+
### Step Status customisations
5757

5858
![Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/android_stepview.png)
5959

6060
* Multiline Text Support: View automatically adjusts line length to make sure words or alphabets from one line do not crossover to next line.
6161
However, If you want to strictly obey line length set ```app:strictObeyLineLength= "true"```.
62-
* To add font to description simply refer to the font file from res/font directory.
63-
* Ensure a minimum margin between description texts in case they are too close.
64-
* Set top margin of a status description from its corresponding circle.
65-
* Align all descriptions at the same level in case, a zoom level is set to current status.
66-
* Set text color to status descriptions.
62+
* To add font to status simply refer to the font file from res/font directory.
63+
* Ensure a minimum margin between status texts in case they are too close.
64+
* Set top margin of a status text from its corresponding circle.
65+
* Align all status at the same level in case, a zoom level is set to current step.
66+
* Set text color to status.
6767

6868
```XML
69-
app:currentStatusZoom="0.3"
70-
app:statusTextFont="@font/lekton_r"
71-
app:statusTextTopMargin="15dp"
72-
app:minStatusTextAdjacentMargin="5dp"
73-
app:alignStatusTextWithCurrent="true"
74-
app:textColorStatusText="#000000"
69+
app:currentStepZoom="0.3"
70+
app:statusFont="@font/lekton_r"
71+
app:statusTopMargin="15dp"
72+
app:minStatusAdjacentMargin="5dp"
73+
app:alignStatusWithCurrent="true"
74+
app:textColorStatus="#000000"
7575
```
7676

7777
### Scrolling property

0 commit comments

Comments
 (0)