diff --git a/CHANGELOG.md b/CHANGELOG.md index 1570074..41a2c6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +#### [1.7.3] - Documentation updated +* Github repo open +* Description inside the library +* Github issues now open + #### [1.7.2] - Delay fixed Fixed: Some issue in version 1.7.1 was blocking the delay. diff --git a/lib/animate_do.dart b/lib/animate_do.dart index babcf72..049d2d2 100644 --- a/lib/animate_do.dart +++ b/lib/animate_do.dart @@ -1,14 +1,32 @@ import 'package:flutter/material.dart'; -/* - Author: Fernando Herrera - website: fernando-herrera.com - Version: 1.7.2 -*/ - -// ==================================== -// Begin Fades -// ==================================== -// ============= FadeIn + +/// Author: Fernando Herrera +/// website: fernando-herrera.com + +/// General information +/// All the widgets are stateful that tracks the state and everything happends there. +/// The Widget definition contains the properties and the state the animation itself. +/// +/// [key] is the widget key for references +/// [child] is the widget to animate +/// [duration] is the duration that you want for the animation +/// [delay] is the delay that you want before the animation starts +/// [manualTrigger] will help you to prevent any animation until you call it via the +/// animation controller, [controller] is a normal AnimationController class that +/// contains the forward, repeat and everything else to control the animation. +/// [animate] is a boolean property that will trigger the animation when is set to true, +/// this is very useful if you use StatefulWidgets with setState or other State Management system. + +/// Some Animations contains special properties +/// [from] will help you to change how far the animation should start or end +/// [spins] is related to the number of spins that you want for certain animation +/// [infinite] gives you the power to never stop the animation + +/// =================================== +/// [Fades] +/// =================================== +/// +/// [FadeIn] Widget definition and its properties class FadeIn extends StatefulWidget { final Key key; final Widget child; @@ -81,7 +99,8 @@ class _FadeInState extends State with SingleTickerProviderStateMixin { } } -// ============= FadeInDown +/// +/// [FadeInDown] Widget definition and its properties class FadeInDown extends StatefulWidget { final Key key; final Widget child; @@ -165,7 +184,8 @@ class _FadeInDownState extends State } } -// ============= FadeInDownBig +/// +/// [FadeInDownBig] Widget definition and its properties class FadeInDownBig extends StatelessWidget { final Key key; final Widget child; @@ -204,7 +224,8 @@ class FadeInDownBig extends StatelessWidget { from: from); } -// ============= FadeInUp +/// +/// [FadeInUp] Widget definition and its properties class FadeInUp extends StatefulWidget { final Key key; final Widget child; @@ -286,7 +307,8 @@ class _FadeInUpState extends State } } -// ============= FadeInUpBig +/// +/// [FadeInUpBig] Widget definition and its properties class FadeInUpBig extends StatelessWidget { final Key key; final Widget child; @@ -326,7 +348,8 @@ class FadeInUpBig extends StatelessWidget { ); } -// ============= FadeInLeft +/// +/// [FadeInLeft] Widget definition and its properties class FadeInLeft extends StatefulWidget { final Key key; final Widget child; @@ -408,7 +431,8 @@ class _FadeInLeftState extends State } } -// ============= FadeInLeftBig +/// +/// [FadeInLeftBig] Widget definition and its properties class FadeInLeftBig extends StatelessWidget { final Key key; final Widget child; @@ -448,7 +472,8 @@ class FadeInLeftBig extends StatelessWidget { ); } -// ============= FadeInRight +/// +/// [FadeInRight] Widget definition and its properties class FadeInRight extends StatefulWidget { final Key key; final Widget child; @@ -530,7 +555,8 @@ class _FadeInRightState extends State } } -// ============= FadeInRightBig +/// +/// [FadeInRightBig] Widget definition and its properties class FadeInRightBig extends StatelessWidget { final Key key; final Widget child; @@ -569,14 +595,17 @@ class FadeInRightBig extends StatelessWidget { from: from, ); } -// ==================================== -// End Fades -// ==================================== -// ==================================== -// Begin Bounce -// ==================================== -// ============= BounceInDown +/// =================================== +/// [END of Fades] +/// =================================== + +/// =================================== +/// [Bounce] +/// =================================== + +/// +/// [BounceInDown] Widget definition and its properties class BounceInDown extends StatefulWidget { final Key key; final Widget child; @@ -656,7 +685,8 @@ class _BounceInDownState extends State } } -// ============= BounceInUp +/// +///[BounceInUp] class BounceInUp extends StatelessWidget { final Key key; final Widget child; @@ -696,7 +726,8 @@ class BounceInUp extends StatelessWidget { ); } -// ============= BounceInLeft +/// +/// [BounceInLeft] Widget definition and its properties class BounceInLeft extends StatefulWidget { final Key key; final Widget child; @@ -778,7 +809,8 @@ class _BounceInLeftState extends State } } -// ============= BounceInRight +/// +/// [BounceInRight] Widget definition and its properties class BounceInRight extends StatelessWidget { final Key key; final Widget child; @@ -817,14 +849,17 @@ class BounceInRight extends StatelessWidget { from: from * -1, ); } -// ==================================== -// End Bounce -// ==================================== -// ==================================== -// Begin Elastics -// ==================================== -// ============= ElasticIn +/// =================================== +/// [End Bounce] +/// =================================== + +/// =================================== +/// [Elastics] +/// =================================== + +/// +/// [ElasticIn] Widget definition and its properties class ElasticIn extends StatefulWidget { final Key key; final Widget child; @@ -906,7 +941,8 @@ class _ElasticInState extends State } } -// ============= ElasticInDown +/// +/// [ElasticInDown] Widget definition and its properties class ElasticInDown extends StatefulWidget { final Key key; final Widget child; @@ -1003,7 +1039,8 @@ class _ElasticInDownState extends State } } -// ============= ElasticInUp +/// +/// [ElasticInUp] Widget definition and its properties class ElasticInUp extends StatelessWidget { final Key key; final Widget child; @@ -1044,7 +1081,8 @@ class ElasticInUp extends StatelessWidget { ); } -// ============= ElasticInLeft +/// +/// [ElasticInLeft] Widget definition and its properties class ElasticInLeft extends StatefulWidget { final Key key; final Widget child; @@ -1141,7 +1179,8 @@ class _ElasticInLeftState extends State } } -// ============= ElasticInRight +/// +/// [ElasticInRight] Widget definition and its properties class ElasticInRight extends StatelessWidget { final Key key; final Widget child; @@ -1180,15 +1219,17 @@ class ElasticInRight extends StatelessWidget { from: from * -1, to: -100); } -// ==================================== -// End Elastics -// ==================================== -// ==================================== -// Begin Flips -// ==================================== +/// ==================================== +/// [End Elastics] +/// ==================================== + +/// ==================================== +/// [Flips] +/// ==================================== -// ============= FlipInX +/// +/// [FlipInX] Widget definition and its properties class FlipInX extends StatefulWidget { final Key key; final Widget child; @@ -1270,7 +1311,8 @@ class _FlipInXState extends State with SingleTickerProviderStateMixin { } } -// ============= FlipInY +/// +/// [FlipInY] Widget definition and its properties class FlipInY extends StatefulWidget { final Key key; final Widget child; @@ -1352,14 +1394,16 @@ class _FlipInYState extends State with SingleTickerProviderStateMixin { } } -// ==================================== -// End Flips -// ==================================== +/// ==================================== +/// [End Flips] +/// ==================================== -// ==================================== -// Begin SlideIns -// ==================================== -// ============= SlideInUp +/// ==================================== +/// [SlideIns] +/// ==================================== + +/// +/// [SlideInUp] Widget definition and its properties class SlideInUp extends StatefulWidget { final Key key; final Widget child; @@ -1435,7 +1479,8 @@ class _SlideInUpState extends State } } -// ============= SlideInDown +/// +/// [SlideInDown] Widget definition and its properties class SlideInDown extends StatelessWidget { final Key key; final Widget child; @@ -1475,7 +1520,8 @@ class SlideInDown extends StatelessWidget { ); } -// ============= SlideInLeft +/// +/// [SlideInLeft] Widget definition and its properties class SlideInLeft extends StatefulWidget { final Key key; final Widget child; @@ -1551,7 +1597,8 @@ class _SlideInLeftState extends State } } -// ============= SlideInRight +/// +/// [SlideInRight] Widget definition and its properties class SlideInRight extends StatelessWidget { final Key key; final Widget child; @@ -1590,15 +1637,17 @@ class SlideInRight extends StatelessWidget { from: from * -1, ); } -// ==================================== -// End SlideIns -// ==================================== -// ==================================== -// Begin Special Ins -// ==================================== +/// ==================================== +/// [End SlideIns] +/// ==================================== + +/// ==================================== +/// [Special Ins] +/// ==================================== -// ============= JelloIn +/// +/// [JelloIn] Widget definition and its properties class JelloIn extends StatefulWidget { final Key key; final Widget child; @@ -1681,14 +1730,17 @@ class _JelloInState extends State with SingleTickerProviderStateMixin { }); } } -// ==================================== -// End Special Ins -// ==================================== -// ==================================== -// Begin Attention Seekers -// ==================================== -// ============= Bounce +/// ==================================== +/// [End Special Ins] +/// ==================================== + +/// ==================================== +/// [Attention Seekers] +/// ==================================== + +/// +/// [Bounce] Widget definition and its properties class Bounce extends StatefulWidget { final Key key; final Widget child; @@ -1780,7 +1832,8 @@ class _BounceState extends State with SingleTickerProviderStateMixin { } } -// ============= Flash +/// +/// [Flash] Widget definition and its properties class Flash extends StatefulWidget { final Key key; final Widget child; @@ -1872,7 +1925,8 @@ class _FlashState extends State with SingleTickerProviderStateMixin { } } -// ============= Pulse +/// +/// [Pulse] Widget definition and its properties class Pulse extends StatefulWidget { final Key key; final Widget child; @@ -1956,7 +2010,8 @@ class _PulseState extends State with SingleTickerProviderStateMixin { } } -// ============= Swing +/// +/// [Swing] Widget definition and its properties class Swing extends StatefulWidget { final Key key; final Widget child; @@ -2078,7 +2133,8 @@ class _SwingState extends State with SingleTickerProviderStateMixin { } } -// ============= Spin +/// +/// [Spin] Widget definition and its properties class Spin extends StatefulWidget { final Key key; final Widget child; @@ -2159,7 +2215,8 @@ class _SpinState extends State with SingleTickerProviderStateMixin { } } -// ============= SpinPerfect +/// +/// [SpinPerfect] Widget definition and its properties class SpinPerfect extends StatefulWidget { final Key key; final Widget child; @@ -2241,7 +2298,8 @@ class _SpinPerfectState extends State } } -// ============= Dance +/// +/// [Dance] Widget definition and its properties class Dance extends StatefulWidget { final Key key; final Widget child; @@ -2335,7 +2393,8 @@ class _DanceState extends State with SingleTickerProviderStateMixin { } } -// ============= Roulette +/// +/// [Roulette] Widget definition and its properties class Roulette extends StatefulWidget { final Key key; final Widget child; @@ -2417,14 +2476,16 @@ class _RouletteState extends State } } -// ==================================== -// End Attention Seekers -// ==================================== +/// ==================================== +/// [End Attention Seekers] +/// ==================================== + +/// ==================================== +/// [FadeOuts] +/// ==================================== -// ==================================== -// FadeOuts Animations -// ==================================== -// ============= FadeOut +/// +/// [FadeOut] Widget definition and its properties class FadeOut extends StatefulWidget { final Key key; final Widget child; @@ -2498,7 +2559,8 @@ class _FadeOutState extends State with SingleTickerProviderStateMixin { } } -// ============= FadeOutDown +/// +/// [FadeOutDown] Widget definition and its properties class FadeOutDown extends StatefulWidget { final Key key; final Widget child; @@ -2582,7 +2644,8 @@ class _FadeOutDownState extends State } } -// ============= FadeOutDownBig +/// +/// [FadeOutDownBig] Widget definition and its properties class FadeOutDownBig extends StatelessWidget { final Key key; final Widget child; @@ -2622,7 +2685,8 @@ class FadeOutDownBig extends StatelessWidget { ); } -// ============= FadeOutUp +/// +/// [FadeOutUp] Widget definition and its properties class FadeOutUp extends StatefulWidget { final Key key; final Widget child; @@ -2704,7 +2768,8 @@ class _FadeOutUpState extends State } } -// ============= FadeOutUpBig +/// +/// [FadeOutUpBig] Widget definition and its properties class FadeOutUpBig extends StatelessWidget { final Key key; final Widget child; @@ -2744,7 +2809,8 @@ class FadeOutUpBig extends StatelessWidget { ); } -// ============= FadeOutLeft +/// +/// [FadeOutLeft] Widget definition and its properties class FadeOutLeft extends StatefulWidget { final Key key; final Widget child; @@ -2826,7 +2892,8 @@ class _FadeOutLeftState extends State } } -// ============= FadeOutLeftBig +/// +/// [FadeOutLeftBig] Widget definition and its properties class FadeOutLeftBig extends StatelessWidget { final Key key; final Widget child; @@ -2866,7 +2933,8 @@ class FadeOutLeftBig extends StatelessWidget { ); } -// ============= FadeOutRight +/// +/// [FadeOutRight] Widget definition and its properties class FadeOutRight extends StatelessWidget { final Key key; final Widget child; @@ -2906,7 +2974,8 @@ class FadeOutRight extends StatelessWidget { ); } -// ============= FadeOutRightBig +/// +/// [FadeOutRightBig] Widget definition and its properties class FadeOutRightBig extends StatelessWidget { final Key key; final Widget child; @@ -2946,14 +3015,16 @@ class FadeOutRightBig extends StatelessWidget { ); } -// ==================================== -// End FadeOuts -// ==================================== +/// ==================================== +/// [End FadeOuts] +/// ==================================== + +/// ==================================== +/// [ZoomIn/out Animations] +/// ==================================== -// ==================================== -// Begin ZoomIn/out Animations -// ==================================== -// ============= ZoomIn +/// +/// [ZoomIn] Widget definition and its properties class ZoomIn extends StatefulWidget { final Key key; final Widget child; @@ -3036,7 +3107,8 @@ class _ZoomInState extends State with SingleTickerProviderStateMixin { } } -// ============= ZoomOut +/// +/// [ZoomOut] Widget definition and its properties class ZoomOut extends StatefulWidget { final Key key; final Widget child; @@ -3120,6 +3192,6 @@ class _ZoomOutState extends State with SingleTickerProviderStateMixin { } } -// ==================================== -// End ZoomIn/out Animations -// ==================================== +/// ==================================== +/// [End ZoomIn/out Animations] +/// ==================================== diff --git a/pubspec.lock b/pubspec.lock index 67a7df1..9477cdd 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -1,62 +1,55 @@ # Generated by pub # See https://dart.dev/tools/pub/glossary#lockfile packages: - archive: - dependency: transitive - description: - name: archive - url: "https://pub.dartlang.org" - source: hosted - version: "2.0.11" - args: - dependency: transitive - description: - name: args - url: "https://pub.dartlang.org" - source: hosted - version: "1.5.2" async: dependency: transitive description: name: async url: "https://pub.dartlang.org" source: hosted - version: "2.4.0" + version: "2.4.2" boolean_selector: dependency: transitive description: name: boolean_selector url: "https://pub.dartlang.org" source: hosted - version: "1.0.5" + version: "2.0.0" + characters: + dependency: transitive + description: + name: characters + url: "https://pub.dartlang.org" + source: hosted + version: "1.0.0" charcode: dependency: transitive description: name: charcode url: "https://pub.dartlang.org" source: hosted - version: "1.1.2" - collection: + version: "1.1.3" + clock: dependency: transitive description: - name: collection + name: clock url: "https://pub.dartlang.org" source: hosted - version: "1.14.11" - convert: + version: "1.0.1" + collection: dependency: transitive description: - name: convert + name: collection url: "https://pub.dartlang.org" source: hosted - version: "2.1.1" - crypto: + version: "1.14.13" + fake_async: dependency: transitive description: - name: crypto + name: fake_async url: "https://pub.dartlang.org" source: hosted - version: "2.1.3" + version: "1.1.0" flutter: dependency: "direct main" description: flutter @@ -67,20 +60,13 @@ packages: description: flutter source: sdk version: "0.0.0" - image: - dependency: transitive - description: - name: image - url: "https://pub.dartlang.org" - source: hosted - version: "2.1.4" matcher: dependency: transitive description: name: matcher url: "https://pub.dartlang.org" source: hosted - version: "0.12.6" + version: "0.12.8" meta: dependency: transitive description: @@ -94,28 +80,7 @@ packages: name: path url: "https://pub.dartlang.org" source: hosted - version: "1.6.4" - pedantic: - dependency: transitive - description: - name: pedantic - url: "https://pub.dartlang.org" - source: hosted - version: "1.8.0+1" - petitparser: - dependency: transitive - description: - name: petitparser - url: "https://pub.dartlang.org" - source: hosted - version: "2.4.0" - quiver: - dependency: transitive - description: - name: quiver - url: "https://pub.dartlang.org" - source: hosted - version: "2.0.5" + version: "1.7.0" sky_engine: dependency: transitive description: flutter @@ -127,14 +92,14 @@ packages: name: source_span url: "https://pub.dartlang.org" source: hosted - version: "1.5.5" + version: "1.7.0" stack_trace: dependency: transitive description: name: stack_trace url: "https://pub.dartlang.org" source: hosted - version: "1.9.3" + version: "1.9.5" stream_channel: dependency: transitive description: @@ -162,14 +127,14 @@ packages: name: test_api url: "https://pub.dartlang.org" source: hosted - version: "0.2.11" + version: "0.2.17" typed_data: dependency: transitive description: name: typed_data url: "https://pub.dartlang.org" source: hosted - version: "1.1.6" + version: "1.2.0" vector_math: dependency: transitive description: @@ -177,12 +142,5 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "2.0.8" - xml: - dependency: transitive - description: - name: xml - url: "https://pub.dartlang.org" - source: hosted - version: "3.5.0" sdks: - dart: ">=2.4.0 <3.0.0" + dart: ">=2.9.0-14.0.dev <3.0.0" diff --git a/pubspec.yaml b/pubspec.yaml index 88269c6..e800037 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,11 @@ name: animate_do description: Beautiful animations inspired on Animate.css, every animation is a widget that contains default but customizable values that look attractive. -version: 1.7.2 +version: 1.7.3 homepage: https://fernando-herrera.com +repository: https://github.com/Klerith/animate_do_package +issue_tracker: https://github.com/Klerith/animate_do_package/issues + + environment: sdk: ">=2.1.0 <3.0.0"