j3g
/
f_card_swiper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(docs): update readme

This commit is contained in:
Ricardo Dalarme 2023-01-15 23:02:52 -03:00
parent f1f85e1f05
commit 204c7fd0d5
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,4 +1,6 @@
```card_swiper``` is a Flutter package for a Tinder Card Swiper. ✨ # flutter_card_swiper
```flutter_card_swiper``` is a Flutter package for a Tinder Card Swiper. ✨
It allows swiping in all directions with any Custom Widget (Stateless or Statefull). It allows swiping in all directions with any Custom Widget (Stateless or Statefull).
@ -15,11 +17,6 @@ We build this package because we wanted to:
- NEW: add functions while un-/swiping, on end or when the swiper is disabled - NEW: add functions while un-/swiping, on end or when the swiper is disabled
- NEW: detect the direction (left, right, top, bottom) in which the card was swiped away - NEW: detect the direction (left, right, top, bottom) in which the card was swiped away
## ❗NEW Features ❗
### Trigger swipe left and swipe right through controller
You can now trigger swipe left and swipe right with our ```CardSwiperController``` regardless of the chosen ```AppinioSwipeDirection``` (which is still used when ```swipe``` is called through the controller). You can call ```swipeLeft``` or ```swipeRight``` through the controller anywhere you want.
### Detect direction of swipe ### Detect direction of swipe
We've added the direction in which the card was swiped away to the function ```onSwipe```. The ```AppinioSwipeDirection``` gets now returned when the function gets called. We've added the direction in which the card was swiped away to the function ```onSwipe```. The ```AppinioSwipeDirection``` gets now returned when the function gets called.
@ -139,4 +136,8 @@ The ```Controller``` is used to control the ```swipe```, ```swipeLeft```, ```swi
| swipeRight | Changes the state of the controller to swipe right and swipes the card to the right side. | swipeRight | Changes the state of the controller to swipe right and swipes the card to the right side.
<hr/> <hr/>
Made with ❤ by Flutter team at <a href="https://appinio.com">Appinio GmbH</a>
## Credits
- **Ricardo Dalarme** (Package maintainer)
- [**Appinio GmbH**](https://appinio.com) (Original project creator)