Skip to content

Commit a4277d6

Browse files
authored
Update README.md
1 parent 112c874 commit a4277d6

File tree

1 file changed

+72
-16
lines changed

1 file changed

+72
-16
lines changed

README.md

+72-16
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A customizable and easy-to-use Timeline View library for Android
55

66
Can be used as a standalone view or as a RecyclerView decorator
77

8-
![header](https://github.com/lriccardo/TimelineView/blob/main/screens/header.png)
8+
![header](https://raw.githubusercontent.com/lriccardo/TimelineView/main/screens/header.png)
99
## Setup
1010

1111
### 1. Add Jitpack to your root build.gradle
@@ -39,23 +39,29 @@ dependencies {
3939
app:indicator_color="@color/teal_700"
4040
app:line_color="@color/teal_700" />
4141
```
42-
- View types
42+
- Previews
4343
<table>
44+
<th>View type</th>
45+
<th>Preview</th>
4446
<th>View type</th>
4547
<th>Preview</th>
4648
<th>View type</th>
4749
<th>Preview</th>
4850
<tr>
4951
<td>first</td>
50-
<td><img src="https://github.com/lriccardo/TimelineView/blob/main/screens/first.jpg" alt="first" width="200"/></td>
52+
<td><img src="https://github.com/lriccardo/TimelineView/raw/main/screens/first.jpg" alt="first" width="200"/></td>
5153
<td>middle</td>
52-
<td><img src="https://github.com/lriccardo/TimelineView/blob/main/screens/middle.jpg" alt="middle" width="200"/></td>
54+
<td><img src="https://github.com/lriccardo/TimelineView/raw/main/screens/middle.jpg" alt="middle" width="200"/></td>
55+
<td>checked</td>
56+
<td><img src="https://github.com/lriccardo/TimelineView/raw/main/screens/middle_checked.jpg" alt="checked" width="200"/></td>
5357
</tr>
5458
<tr>
5559
<td>last</td>
56-
<td><img src="https://github.com/lriccardo/TimelineView/blob/main/screens/last.jpg" alt="last" width="200"/></td>
60+
<td><img src="https://github.com/lriccardo/TimelineView/raw/main/screens/last.jpg" alt="last" width="200"/></td>
5761
<td>spacer</td>
58-
<td><img src="https://github.com/lriccardo/TimelineView/blob/main/screens/spacer.jpg" alt="spacer" width="200"/></td>
62+
<td><img src="https://github.com/lriccardo/TimelineView/raw/main/screens/spacer.jpg" alt="spacer" width="200"/></td>
63+
<td>dashed</td>
64+
<td><img src="https://github.com/lriccardo/TimelineView/raw/main/screens/middle_dashed.jpg" alt="dashed" width="200"/></td>
5965
</tr>
6066
</table>
6167

@@ -71,27 +77,57 @@ dependencies {
7177
<td>first</td>
7278
</tr>
7379
<tr>
74-
<td>app:indicator_size</td>
75-
<td>Dimension</td>
76-
<td>12dp</td>
80+
<td>app:indicator_style</td>
81+
<td>filled | empty | checked</td>
82+
<td>filled</td>
7783
</tr>
7884
<tr>
79-
<td>app:line_width</td>
85+
<td>app:indicator_size</td>
8086
<td>Dimension</td>
81-
<td>indicator_size/1.61</td>
87+
<td>12dp</td>
8288
</tr>
8389
</tr>
8490
<tr>
8591
<td>app:indicator_color</td>
8692
<td>Color</td>
8793
<td>Color.RED</td>
8894
</tr>
95+
<tr>
96+
<td>app:checked_indicator_size</td>
97+
<td>Dimension</td>
98+
<td>6dp</td>
99+
</tr>
100+
<tr>
101+
<td>app:checked_indicator_stroke_width</td>
102+
<td>Dimension</td>
103+
<td>4dp</td>
104+
</tr>
105+
<tr>
106+
<td>app:line_style</td>
107+
<td>normal | dashed</td>
108+
<td>normal</td>
109+
</tr>
110+
<tr>
111+
<td>app:line_width</td>
112+
<td>Dimension</td>
113+
<td>8dp</td>
114+
</tr>
89115
</tr>
90116
<tr>
91117
<td>app:line_color</td>
92118
<td>Color</td>
93119
<td>Color.RED</td>
94120
</tr>
121+
<tr>
122+
<td>app:line_dash_length</td>
123+
<td>Dimension</td>
124+
<td>18</td>
125+
</tr>
126+
<tr>
127+
<td>app:line_dash_gap</td>
128+
<td>Dimension</td>
129+
<td>12</td>
130+
</tr>
95131
</table>
96132

97133
### RecyclerView Decorator
@@ -114,20 +150,40 @@ recyclerView.addItemDecoration(
114150
<th>Field</th>
115151
<th>Accepted values</th>
116152
<th>Default</th>
153+
<tr>
154+
<td>indicatorStyle</td>
155+
<td>IndicatorStyle (Filled | Empty | Checked)</td>
156+
<td>Filled</td>
157+
</tr>
117158
<tr>
118159
<td>indicatorSize</td>
119160
<td>Float</td>
120161
<td>24f</td>
121162
</tr>
163+
<tr>
164+
<td>checkedIndicatorSize</td>
165+
<td>Float</td>
166+
<td>TimelineView default value</td>
167+
</tr>
168+
<tr>
169+
<td>checkedIndicatorStrokeWidth</td>
170+
<td>Float</td>
171+
<td>4dp</td>
172+
</tr>
173+
<tr>
174+
<td>lineStyle</td>
175+
<td>Normal (Normal | Dashed)</td>
176+
<td>TimelineView default value</td>
177+
</tr>
122178
<tr>
123179
<td>lineWidth</td>
124180
<td>Float</td>
125-
<td>indicatorSize/1.61</td>
181+
<td>TimelineView default value</td>
126182
</tr>
127183
<tr>
128184
<td>padding</td>
129185
<td>Float</td>
130-
<td>indicatorSize*2</td>
186+
<td>16dp/td>
131187
</tr>
132188
<tr>
133189
<td>position</td>
@@ -137,12 +193,12 @@ recyclerView.addItemDecoration(
137193
<tr>
138194
<td>indicatorColor</td>
139195
<td>@ColorInt</td>
140-
<td>Color.RED</td>
196+
<td>TimelineView default value</td>
141197
</tr>
142198
</tr>
143199
<tr>
144-
<td>lineColorr</td>
200+
<td>lineColor</td>
145201
<td>@ColorInt</td>
146-
<td>Color.RED</td>
202+
<td>TimelineView default value</td>
147203
</tr>
148204
</table>

0 commit comments

Comments
 (0)