Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DanielCardonaRojas/flicked_cards
A card swiping widget supporting custom animations.
https://github.com/DanielCardonaRojas/flicked_cards
animations card dart flutter gesture swipe
Last synced: 7 days ago
JSON representation
A card swiping widget supporting custom animations.
- Host: GitHub
- URL: https://github.com/DanielCardonaRojas/flicked_cards
- Owner: DanielCardonaRojas
- License: mit
- Created: 2021-07-09T14:42:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-08T12:05:19.000Z (about 3 years ago)
- Last Synced: 2024-08-01T12:23:54.752Z (3 months ago)
- Topics: animations, card, dart, flutter, gesture, swipe
- Language: Dart
- Homepage:
- Size: 15.9 MB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# flicked_cards
A gesture driven card swipping widget supporting custom animations.
## Features
- Awesome default animations provided out of the box
- Progress through cards swipping both direction or in a single direction
- Extensible through custom provided animations
- Support piling or popping (depending on animation spec)
## Examples
Here are some of the animation provided out of the box, take a look at the example to see all.
Cards used in these examples where taken from [Brocodev](https://github.com/brocodev/flutter_projects)
**Example usage**
```dart
FlickedCards(
count: Superhero.marvelHeroes.length,
animationStyle: FlipAnimation(),
onSwiped: (idx, dir) => print('>>> $dir $idx'),
builder: (index, progress, context) {
final superHeroe = Superhero.marvelHeroes[index];
return Container(
child: Center(
child: SuperheroCard(
superhero: superHeroe,
factorChange: 1 - progress),
),
);
},
)
```
# Custom animations
`flicked_cards` provides an easy way to create custom animations but it is required to have a basic understanding
of how cards can be layed out and how to position them depending on the drag progress and some of the properties in `AnimationConfig`.
Animations will be provided a `progress` value in the range (-1, 1) you should try to make you animation symmetric around 0
when posible. Like this:
You will have to reason about relative card indices:
## Interface for animations
All animations will need to implement `CardAnimation` which basically
defines:
- animation of a particular card depending on swipe progress `required`
- opacity of a particular card depending on swipe progress `optional`
- where to apply transformations on cards (Fractional Offset)
```dart
typedef SwipeAnimation = Matrix4 Function(double progress);
typedef OpacityAnimation = double Function(double progress);
abstract class CardAnimation {
AnimationConfig get config;
LayoutConfig get layoutConfig;
SwipeAnimation animationForCard({required int relativeIndex});
OpacityAnimation opacityForCard({required int relativeIndex}) {
return (_) => 1;
}
FractionalOffset fractionalOffsetForCard({required int relativeIndex});
}
```
Additionally to make this process a bit easier, 2 extra abstract classes that implement
`CardAnimation` which are:
- `SymmetricCardAnimation`
- `AsymmetricCardAnimation`
Carousel animation is an example of a `SymmetricCardAnimation` take a look [here](https://github.com/DanielCardonaRojas/flicked_cards/blob/main/lib/src/animations/carousel_animation.dart)
If struggling to make the animationlook at how the animations provided out of the box where implemented: [here](https://github.com/DanielCardonaRojas/flicked_cards/tree/main/lib/src/animations)
## Card layouts
Internally cards are placed in `Stack` widget so an animation can choose to work with a single or both of the following
layouts:
Note that depending on the index some of cards will not be displayed:
