chore(docs): update readme

This commit is contained in:
Ricardo Dalarme 2023-01-12 21:44:47 -03:00
parent 2b92e3577d
commit e70b6e77bc
1 changed files with 46 additions and 47 deletions

View File

@ -1,67 +1,66 @@
# swipeable_cards_stack # swipeable_cards_stack
**This is Tinder like swipeable cards package. You can add your own widgets to the stack, receive all four events, left, right, up and down. You can define your own business logic for each direction.** This is Tinder like swipeable cards package. You can add your own widgets to the stack, receive all four events, left, right, up and down. You can define your own business logic for each direction.
<img alt="Demo" src="images/swipe-card.gif" height="500"> <img alt="Demo" src="images/swipe-card.gif" height="500">
## Documentation ## Documentation
### Installation ### Installation
Add `swipeable_cards_stack` to your `pubspec.yaml`: Add `swipeable_cards_stack` to your `pubspec.yaml`:
``` ```yaml
dependencies: dependencies:
flutter:
sdk: flutter
# added below
swipeable_cards_stack: <latest version> swipeable_cards_stack: <latest version>
``` ```
### Adding to app
### Usage
Use the `SwipeableCardsStack` widget provided by the package Use the `SwipeableCardsStack` widget provided by the package
``` ```dart
@override import 'package:swipeable_cards_stack/swipeable_cards_stack.dart';
Widget build(BuildContext context) {
//create a SwipeableCardsStackController
SwipeableCardsStackController _cardController = SwipeableCardsStackController();
return Scaffold( class MyWidget extends StatefulWidget {
appBar: AppBar( @override
title: Text(widget.title), State<MyWidget> createState() => _MyWidgetState();
), }
body: Column(
mainAxisAlignment: MainAxisAlignment.spaceBetween, class _MyWidgetState extends State<MyWidget> {
children: [ final _cardsController = SwipeableCardsStackController();
SwipeableCardsStack(
cardController: _cardController, @override
Widget build(BuildContext context) {
return SwipeableCardsStack(
cardController: _cardsController,
context: context, context: context,
//add the first 3 cards (widgets) // Add the first 3 cards (widgets)
items: [ items: [
CardView(text: "First card"), CardView(text: "First card"),
CardView(text: "Second card"), CardView(text: "Second card"),
CardView(text: "Third card"), CardView(text: "Third card"),
], ],
//Get card swipe event callbacks // Get card swipe event callbacks
onCardSwiped: (dir, index, widget) { onCardSwiped: (dir, index, widget) {
//Add the next card using _cardController // Add the next card using _cardController
_cardController.addItem(CardView(text: "Next card")); _cardsController.addItem(CardView(text: "Next card"));
//Take action on the swiped widget based on the direction of swipe // Take action on the swiped widget based on the direction of swipe
//Return false to not animate cards // Return false to not animate cards
}, },
//
enableSwipeUp: true, enableSwipeUp: true,
enableSwipeDown: false, enableSwipeDown: false,
), );
//other children
)
} }
}
``` ```
### Author ### Contributing
[**CodeToArt Technology**](https://github.com/codetoart)
- Follow us on **Twitter**: [**@codetoart**](https://twitter.com/codetoart) If you want to contribute to this project, you may easily create issues and send PRs. Please take note that your code contributions will be applicable under MIT license unless specified otherwise.
- Contact us on **Website**: [**codetoart**](http://www.codetoart.com)
### Credits
- **Ricardo Dalarme** (Package maintainer)
- [**CodeToArt Technology**](https://github.com/codetoart) (Original project creator)