Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/thecodepapaya/show_up_animation

A flutter package to simplify the common "show up" animation
https://github.com/thecodepapaya/show_up_animation

animation flutter package pubdev

Last synced: 18 days ago
JSON representation

A flutter package to simplify the common "show up" animation

Lists

README

        

# show_up_animation [![Build Status](https://travis-ci.com/thecodepapaya/show_up_animation.svg?branch=master)](https://travis-ci.com/thecodepapaya/show_up_animation)

A flutter package to simplify the implementation of "show up" animation

## Getting Started

Install dependencies

```yaml
dependencies:
show_up_animation: ^1.0.2
```

Then import wherever you want to implement the animation

```dart
import 'package:show_up_animation/show_up_animation.dart';
```

### ShowUpAnimation

Wrap any widget you want to animate inside `ShowUpAnimation` widget and provide a `Duration()` to `delayStart` field to control after how much delay the animation fires.

```dart
ShowUpAnimation(
delayStart: Duration(seconds: 1),
animationDuration: Duration(seconds: 1),
curve: Curves.bounceIn,
direction: Direction.vertical,
offset: 0.5,
child: YourWidget(),
),
```

### ShowUpList

To create a list of "show up" animations, use `ShowUpList` and provide
your list of widgets to `children` parameter.

```dart
ShowUpList(
direction: Direction.horizontal,
animationDuration: Duration(milliseconds: 1500),
delayBetween: Duration(milliseconds: 800),
offset: -0.2,
children: [
Widget1(),
Widget2(),
Widget3(),
Widget4(),
],
),
```

## Properties

### ShowUpAnimation Properties

You can customize how to do you want to animate your `child` using the parameters described below.

| Property | Function |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| child | The widget on which to apply the given `ShowUpAnimation` |
| offset | The offset by which to slide and [child] into view from [Direction]. Use negative value to reverse animation [direction]. Defaults to 0.2 |
| curve | The curve used to animate the [child] into view. Defaults to [Curves.easeIn] |
| direction | horizontal or vertical |
| delayStart | The delay with which to animate the [child]. Takes in a [Duration] and defaults to 0 seconds |
| animationDuration | The total duration in which the animation completes. Defaults to 800 milliseconds |

### ShowUpList Properties

| Property | Function |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| children | The list of widgets on which to apply the given `ShowUpAnimation` |
| offset | The offset by which to slide and [child] into view from [Direction]. Use negative value to reverse animation [direction]. Defaults to 0.2 |
| curve | The curve used to animate each [child] into view. Defaults to [Curves.easeIn] |
| direction | horizontal or vertical |
| delayBetween | he delay between animating each [children] into view. Takes in a [Duration] and defaults to 300 milliseconds |
| animationDuration | The total duration in which the animation of each child completes. Defaults to 500 milliseconds |

## Demo

![videotogif_2020 04 21_19 44 01](https://user-images.githubusercontent.com/42690541/79876554-d2d4fd00-8408-11ea-9b8e-550954f618f3.gif)
![videotogif_2020 04 30_04 07 18](https://user-images.githubusercontent.com/42690541/80653893-c3088900-8a98-11ea-818a-27c55aa53789.gif)