Skip to content

Commit 9f3a6e2

Browse files
committed
dev: Readme edit
1 parent d2f20a3 commit 9f3a6e2

File tree

8 files changed

+139
-24
lines changed

8 files changed

+139
-24
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*.iml
22
.gradle
33
/local.properties
4+
*.idea
45
/.idea/libraries
56
/.idea/modules.xml
67
/.idea/workspace.xml

.idea/markdown-navigator.xml

Lines changed: 78 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/markdown-navigator/profiles_settings.xml

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/misc.xml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 56 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,81 @@
22
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.
33

44
## Usage
5-
Here is a basic example of a StepView
65

7-
![alt Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/basic_stepview.png)
6+
### A customised StepView
87

9-
```
10-
<params.com.statusView.StatusViewScroller
11-
android:id="@+id/statusView"
12-
android:layout_width="wrap_content"
13-
android:layout_height="wrap_content"
14-
app:circleColor="#F1EA7F"
15-
app:circleRadius="20dp"
16-
app:complete_drawable="@drawable/ic_done_black_24dp"
17-
app:statusCount="4"
18-
app:currentCount="4"
19-
app:drawCount="true"
20-
android:entries="@array/statuses" />
21-
```
22-
![alt Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/colors_stepview.png)
8+
![Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/colors_stepview.png)
239

24-
```
10+
* Set total step count and current count.
11+
12+
* Set different dimensions for stroke width, line width, text size of label (step count) & line Gap.
13+
14+
* Stroke color (circle), fill color (circle), line color & label text color can be set differently for completed, current & incomplete states.
15+
16+
```XML
2517
<params.com.statusView.StatusViewScroller
26-
android:id="@+id/statusView"
2718
android:layout_width="wrap_content"
2819
android:layout_height="wrap_content"
29-
app:circleColorType="fillStroke"
30-
app:lineGap="5dp"
3120
app:statusCount="5"
3221
app:currentCount="4"
3322
app:drawCount="true"
3423
android:entries="@array/statuses"
24+
app:circleColorType="fillStroke"
25+
app:lineGap="5dp"
3526
app:lineWidth="3dp"
36-
app:lineColorIncomplete="#B4B7BA"
3727
app:lineColor="@android:color/black"
28+
app:lineColorIncomplete="#B4B7BA"
3829
app:lineColorCurrent="#91A8D0"
3930
app:circleColor="#CC004B8D"
40-
app:circleColorIncomplete="#BCBCBE"
4131
app:circleColorCurrent="#004B8D"
32+
app:circleColorIncomplete="#BCBCBE"
4233
app:textColorLabels="@android:color/white"
4334
app:textColorLabelsCurrent="@android:color/white"
4435
app:textColorLabelsIncomplete="@android:color/black"
4536
app:circleStrokeWidth="4dp"
4637
app:circleStrokeColorCurrent="#91A8D0"
38+
app:textSizeLabels="15sp"
4739
app:complete_drawable="@drawable/ic_done_black_24dp" />
4840
```
49-
You can set colors
41+
42+
### Some more customisations
43+
44+
![Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/drawable_zoom_stepview.png)
45+
46+
* Set a zoom value to your current step
47+
* Set different drawables for completed, current & incomplete states.
48+
49+
```XML
50+
app:currentStatusZoom="0.5"
51+
app:complete_drawable="@drawable/ic_satisfied_black_24dp"
52+
app:current_drawable="@drawable/ic_dissatisfied_black_24dp"
53+
app:incomplete_drawable="@drawable/ic_very_dissatisfied_black_24dp"
54+
```
55+
56+
### Step description customisations
57+
58+
![Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/android_stepview.png)
59+
60+
* Multiline Text Support: View automatically adjusts line length to make sure words or alphabets from one line do not crossover to next line.
61+
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.
67+
68+
```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"
75+
```
76+
77+
### Scrolling property
78+
79+
![Downloading..](https://github.com/params-ing/StepViewAndroid/blob/dev/screenshots/fragment_scroll_stepview.gif)
80+
81+
* The view can be scrolled if the content exceeds the available width.
82+
* You can also scroll to a particular step by calling ```statusViewScroller.scrollToPos(stepCount)```

screenshots/android_stepview.png

65.8 KB
Loading
26.6 KB
Loading
1.74 MB
Loading

0 commit comments

Comments
 (0)