Skip to content

Commit d1d26c1

Browse files
Update README.md
1 parent 77b3bfe commit d1d26c1

File tree

1 file changed

+29
-39
lines changed

1 file changed

+29
-39
lines changed

README.md

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -96,87 +96,77 @@ Download the [APK file from here](https://github.com/wajahatkarim3/EasyFlipViewP
9696
Add `EasyFlipViewPager` in app's ```build.gradle``` file:
9797

9898
```groovy
99-
implementation 'com.wajahatkarim3.easyflipviewpager:easyflipviewpager:1.2.0'
99+
implementation 'com.wajahatkarim3.easyflipviewpager:easyflipviewpager:2.0.0'
100100
```
101101
Or add `EasyFlipViewPager` as a new dependency inside your `pom.xml`
102102
```xml
103103
<dependency>
104104
<groupId>com.wajahatkarim3.easyflipviewpager</groupId>
105105
<artifactId>easyflipviewpager</artifactId>
106-
<version>1.2.0</version>
106+
<version>2.0.0</version>
107107
<type>pom</type>
108108
</dependency>
109109
```
110110
## ❓ Usage
111+
112+
### ViewPager
111113
Just create an object of either [`BookFlipPageTransformer`](https://github.com/wajahatkarim3/EasyFlipViewPager/blob/master/easyflipviewpager/src/main/java/com/wajahatkarim3/easyflipviewpager/BookFlipPageTransformer.java) or [`CardFlipPageTransformer`](https://github.com/wajahatkarim3/EasyFlipViewPager/blob/master/easyflipviewpager/src/main/java/com/wajahatkarim3/easyflipviewpager/CardFlipPageTransformer.java) and assign it to your `ViewPager` object by calling `ViewPager#setPageTransformer(true, myTransformerObject)`.
112114

115+
### ViewPager2
116+
Use these new `PageTransformer` classes for `ViewPager2` instance: [`BookFlipPageTransformer2`](https://github.com/wajahatkarim3/EasyFlipViewPager/blob/master/easyflipviewpager/src/main/java/com/wajahatkarim3/easyflipviewpager/BookFlipPageTransformer2.java) or [`CardFlipPageTransformer2`](https://github.com/wajahatkarim3/EasyFlipViewPager/blob/master/easyflipviewpager/src/main/java/com/wajahatkarim3/easyflipviewpager/CardFlipPageTransformer2.java)
117+
113118

114119
### 💳 Card Flip Example
115120
```java
116-
// Get ViewPager and Set Adapter
117-
myViewPager = findViewById(R.id.myViewPager);
121+
// Get ViewPager2 and Set Adapter
122+
myViewPager2 = findViewById(R.id.myViewPager2);
118123
pagerAdapter = new MyPagerAdapter(this);
119-
myViewPager.setAdapter(pagerAdapter);
124+
myViewPager2.setAdapter(pagerAdapter);
120125

121126
// Create an object of page transformer
122-
CardFlipPageTransformer cardFlipPageTransformer = new CardFlipPageTransformer();
127+
CardFlipPageTransformer2 cardFlipPageTransformer = new CardFlipPageTransformer2();
123128

124129
// Enable / Disable scaling while flipping. If false, then card will only flip as in Poker card example.
125130
// Otherwise card will also scale like in Gallery demo. By default, its true.
126131
cardFlipPageTransformer.setScalable(false);
127132

128-
// Set orientation. Either horizontal or vertical. By default, its vertical.
129-
cardFlipPageTransformer.setFlipOrientation(CardFlipPageTransformer.VERTICAL);
130-
131133
// Assign the page transformer to the ViewPager.
132-
myViewPager.setPageTransformer(true, cardFlipPageTransformer);
134+
myViewPager2.setPageTransformer(true, cardFlipPageTransformer);
133135
```
134136

135137
### 📄 Book Flip Example
136138
```java
137-
// Get ViewPager and Set Adapter
138-
myViewPager = findViewById(R.id.myViewPager);
139-
pagerAdapter = new MyPagerAdapter(this);
140-
myViewPager.setAdapter(pagerAdapter);
139+
// Get ViewPager2 and Set Adapter
140+
myViewPager2 = findViewById(R.id.myViewPager2);
141+
pagerAdapter2 = new MyPagerAdapter(this);
142+
myViewPager2.setAdapter(pagerAdapter);
141143

142144
// Create an object of page transformer
143-
BookFlipPageTransformer bookFlipPageTransformer = new BookFlipPageTransformer();
145+
BookFlipPageTransformer2 bookFlipPageTransformer = new BookFlipPageTransformer2();
144146

145147
// Enable / Disable scaling while flipping. If true, then next page will scale in (zoom in). By default, its true.
146148
bookFlipPageTransformer.setEnableScale(true);
147149

148150
// The amount of scale the page will zoom. By default, its 5 percent.
149151
bookFlipPageTransformer.setScaleAmountPercent(10f);
150152

151-
// Assign the page transformer to the ViewPager.
152-
myViewPager.setPageTransformer(true, bookFlipPageTransformer);
153+
// Assign the page transformer to the ViewPager2.
154+
myViewPager2.setPageTransformer(true, bookFlipPageTransformer);
153155
```
154156

155-
## 💰 Donations
156-
157-
This project needs you! If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated (and I love food, coffee and beer). Thank you!
158-
159-
**PayPal**
157+
## 👨 Developed By
160158

161-
* **[Donate $5](https://www.paypal.me/WajahatKarim/5)**: Thank's for creating this project, here's a tea (or some juice) for you!
162-
* **[Donate $10](https://www.paypal.me/WajahatKarim/10)**: Wow, I am stunned. Let me take you to the movies!
163-
* **[Donate $15](https://www.paypal.me/WajahatKarim/15)**: I really appreciate your work, let's grab some lunch!
164-
* **[Donate $25](https://www.paypal.me/WajahatKarim/25)**: That's some awesome stuff you did right there, dinner is on me!
165-
* **[Donate $50](https://www.paypal.me/WajahatKarim/50)**: I really really want to support this project, great job!
166-
* **[Donate $100](https://www.paypal.me/WajahatKarim/100)**: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
167-
* **[Donate $2799](https://www.paypal.me/WajahatKarim/2799)**: Go buddy, buy Macbook Pro for yourself!
159+
<a href="https://twitter.com/WajahatKarim" target="_blank">
160+
<img src="https://avatars1.githubusercontent.com/u/8867121?s=460&v=4" width="70" align="left">
161+
</a>
168162

169-
Of course, you can also choose what you want to donate, all donations are awesome!
163+
**Wajahat Karim**
170164

171-
## 👨 Developed By
165+
[![Twitter](https://img.shields.io/badge/-twitter-grey?logo=twitter)](https://twitter.com/WajahatKarim)
166+
[![Web](https://img.shields.io/badge/-web-grey?logo=appveyor)](https://wajahatkarim.com/)
167+
[![Medium](https://img.shields.io/badge/-medium-grey?logo=medium)](https://medium.com/@wajahatkarim3)
168+
[![Linkedin](https://img.shields.io/badge/-linkedin-grey?logo=linkedin)](https://www.linkedin.com/in/wajahatkarim/)
172169

173-
```
174-
Wajahat Karim
175-
```
176-
- Website (http://wajahatkarim.com)
177-
- Twitter (http://twitter.com/wajahatkarim)
178-
- Medium (http://www.medium.com/@wajahatkarim3)
179-
- LinkedIn (http://www.linkedin.com/in/wajahatkarim)
180170

181171
## 👍 How to Contribute
182172
1. Fork it
@@ -187,7 +177,7 @@ Wajahat Karim
187177

188178
## 📃 License
189179

190-
Copyright 2018 Wajahat Karim
180+
Copyright 2020 Wajahat Karim
191181

192182
Licensed under the Apache License, Version 2.0 (the "License");
193183
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)