Skip to content

Commit 8053a5e

Browse files
authored
Update README.md
1 parent 6d90839 commit 8053a5e

File tree

1 file changed

+29
-31
lines changed

1 file changed

+29
-31
lines changed

README.md

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ A simple utility class to add a background, an icon and a label to a RecyclerVie
44
![Sample app - Swipe right](https://xabaras.github.io/RecyclerViewSwipeDecorator/img/screen01.png)
55
![Sample app - Swipe left](https://xabaras.github.io/RecyclerViewSwipeDecorator/img/screen02.png)
66

7-
N.B In version 1.3 RecyclerViewSwipeDecorator migrated to [AndroidX](https://developer.android.com/jetpack/androidx/migrate)
8-
97
## How do I get set up? ##
108

11-
# Latest Version
9+
In version 1.3 RecyclerViewSwipeDecorator migrated to [AndroidX](https://developer.android.com/jetpack/androidx/migrate)
10+
11+
### Latest Version ###
12+
13+
Get latest version via JitPack
1214

13-
Get latest version via [![](https://jitpack.io/v/xabaras/RecyclerViewSwipeDecorator.svg)](https://jitpack.io/#xabaras/RecyclerViewSwipeDecorator)
15+
[![](https://jitpack.io/v/xabaras/RecyclerViewSwipeDecorator.svg)](https://jitpack.io/#xabaras/RecyclerViewSwipeDecorator)
1416

1517
If you use Gradle add JitPack in your root build.gradle at the end of repositories:
1618
```groovy
@@ -48,7 +50,7 @@ Then add the dependency
4850
</dependency>
4951
```
5052

51-
#Previous versions ~1.2.3
53+
### Previous versions ~1.2.3 ###
5254

5355
Get it via Gradle
5456

@@ -65,7 +67,7 @@ or Maven
6567
</dependency>
6668
```
6769

68-
Currently working to bring latest version to Maven Central.
70+
**Currently working to bring latest version to Maven Central.**
6971

7072
## Usage ##
7173
Here is a non-comprehensive guide to RecyclerViewSwipeDecorator for any further information you can reference the library [javadoc](https://xabaras.github.io/RecyclerViewSwipeDecorator/javadoc/), the sources and/or the sample app sources.
@@ -116,63 +118,59 @@ If you want you can add a label for each swiping direction or setting the icon t
116118
A method to set the action icon margin from the view left/right bound it available too.
117119

118120
##### public Builder addBackgroundColor(int color) #####
119-
Add a background color to both swiping directions
121+
Add a background color to both swiping directions
120122

121123
##### public Builder addActionIcon(int color) #####
122-
Add an action icon to both swiping directions
124+
Add an action icon to both swiping directions
123125

124126
##### public Builder setActionIconTint(int color) #####
125-
Set the tint color for either (left/right) action icons
127+
Set the tint color for either (left/right) action icons
126128

127129
##### public Builder addSwipeRightBackgroundColor(int color) #####
128-
Add a background color to the view while swiping right.
130+
Add a background color to the view while swiping right.
129131

130132
##### public Builder addSwipeRightActionIcon(int color) #####
131-
Add an action icon while swiping right (it's suggested to use 24dp square vector drawables.).
133+
Add an action icon while swiping right (it's suggested to use 24dp square vector drawables.).
132134

133135
##### public Builder setSwipeRightActionIconTint(int color) #####
134-
Set the tint color for action icon shown while swiping right
136+
Set the tint color for action icon shown while swiping right
135137

136138
##### public Builder addSwipeLeftBackgroundColor(int color) #####
137-
Add a background color to the view while swiping left.
139+
Add a background color to the view while swiping left.
138140

139141
##### public Builder addSwipeLeftActionIcon(int color) #####
140-
Add an action icon while swiping left (it's suggested to use 24dp square vector drawables.).
142+
Add an action icon while swiping left (it's suggested to use 24dp square vector drawables.).
141143

142144
##### public Builder setSwipeLeftActionIconTint(int color) #####
143-
Set the tint color for action icon shown while swiping left
144-
145-
~~##### public Builder setIconHorizontalMargin(int iconHorizontalMargin) #####~~
146-
147-
[Deprecated] Set icon horizontal margin from left/right bound of the view (default is 16dp).
145+
Set the tint color for action icon shown while swiping left
148146

149147
##### public Builder setIconHorizontalMargin(int unit, int iconHorizontalMargin) #####
150-
Set icon horizontal margin from left/right bound of the view (default is 16dp).
151-
N.B. unit is a TypedValue (e.g. TypedValue.COMPLEX_UNIT_DIP)
148+
Set icon horizontal margin from left/right bound of the view (default is 16dp).
149+
Unit is a TypedValue (e.g. TypedValue.COMPLEX_UNIT_DIP)
152150

153151
##### public Builder addSwipeRightLabel(String label) #####
154-
Add a label to be shown while swiping right
152+
Add a label to be shown while swiping right
155153

156154
##### public Builder setSwipeRightLabelColor(int color) #####
157-
Set the color of the label to be shown while swiping right
155+
Set the color of the label to be shown while swiping right
158156

159157
##### public Builder setSwipeRightLabelTextSize(int unit, float size) #####
160-
Set the size of the label to be shown while swiping right
161-
N.B. unit is a TypedValue (e.g. TypedValue.COMPLEX_UNIT_SP)
158+
Set the size of the label to be shown while swiping right
159+
Unit is a TypedValue (e.g. TypedValue.COMPLEX_UNIT_SP)
162160

163161
##### public Builder setSwipeRightLabelTypeface(Typeface typeface) #####
164-
Set the Typeface of the label to be shown while swiping right
162+
Set the Typeface of the label to be shown while swiping right
165163

166164

167165
##### public Builder addSwipeLeftLabel(String label) #####
168-
Add a label to be shown while swiping left
166+
Add a label to be shown while swiping left
169167

170168
##### public Builder setSwipeLeftLabelColor(int color) #####
171-
Set the color of the label to be shown while swiping left
169+
Set the color of the label to be shown while swiping left
172170

173171
##### public Builder setSwipeLeftLabelTextSize(int unit, float size) #####
174-
Set the size of the label to be shown while swiping left
175-
N.B. unit is a TypedValue (e.g. TypedValue.COMPLEX_UNIT_SP)
172+
Set the size of the label to be shown while swiping left
173+
Unit is a TypedValue (e.g. TypedValue.COMPLEX_UNIT_SP)
176174

177175
##### public Builder setSwipeLeftLabelTypeface(Typeface typeface) #####
178-
Set the Typeface of the label to be shown while swiping left
176+
Set the Typeface of the label to be shown while swiping left

0 commit comments

Comments
 (0)