Skip to content

Commit

Permalink
Refactor documentation and update package dependencies
Browse files Browse the repository at this point in the history 
- Improve library documentation in animate_do.dart
- Update pubspec.lock with latest package versions
- Enhance code comments in animate_do_mixins.dart
- Minor formatting and clarity improvements
  • Loading branch information
@Klerith
Klerith committed Feb 3, 2025
1 parent 52ae98c commit c4f736f
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 35 deletions.
12 changes: 6 additions & 6 deletions lib/animate_do.dart
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/// Author: Fernando Herrera
/// website: fernando-herrera.com
/// Author: Fernando Herrera
/// Website: https://fernando-herrera.com
/// Null-Safety: checked!
/// Prefer Const: checked!
/// Null-Safety: ✓
/// Prefer const: ✓
/// Animate_do offers a simple and easy way to animate widgets using only native widgets
/// This library is inspired on Animate.css
/// Animate_do provides a simple and elegant way to add animations to Flutter widgets
/// using only native widgets. This library is inspired by Animate.css.
library animate_do;

export 'src/animations/animate_do_attention_seekers.dart';
Expand Down
41 changes: 36 additions & 5 deletions lib/src/types/animate_do_mixins.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,31 @@ import 'package:flutter/widgets.dart';

import '../types/animate_do_types.dart';

/// Provides a common interface for [AnimateDoState]
/// A mixin that provides animation control functionality for Animate_do widgets.
///
/// This mixin handles the core animation logic including:
/// - Animation controller initialization and disposal
/// - Delayed animation triggering
/// - Manual animation control
/// - Infinite animation loops
/// - Animation completion callbacks
/// - Forward/backward animation direction
mixin AnimateDoState {
/// The animation controller that drives the animation
late AnimationController controller;
bool disposed = false;

/// All the animations are controlled by a [AnimationController]
/// The controller is created in the [initState] method of the parent AnimatedWidget
/// This method controls the flow of the animation
/// Whether this animation state has been disposed
bool disposed = false;

/// Configures and starts the animation based on the provided parameters.
///
/// Parameters:
/// - [delay]: Duration to wait before starting the animation
/// - [animate]: Whether the animation should start automatically
/// - [manualTrigger]: Whether animation requires manual triggering
/// - [infinite]: Whether animation should loop infinitely
/// - [onFinish]: Callback function when animation completes
/// - [controllerCallback]: Callback to access the animation controller
void configAnimation({
required Duration delay,
required bool animate,
Expand Down Expand Up @@ -44,6 +60,21 @@ mixin AnimateDoState {
}
}

/// Builds and controls the animation based on the provided parameters.
///
/// This method handles:
/// - Delayed animation start
/// - Infinite animation loops
/// - Animation reversal
/// - Manual animation control
///
/// Parameters:
/// - [delay]: Duration to wait before starting the animation
/// - [animate]: Whether the animation should start automatically
/// - [manualTrigger]: Whether animation requires manual triggering
/// - [infinite]: Whether animation should loop infinitely
/// - [onFinish]: Callback function when animation completes
/// - [controllerCallback]: Callback to access the animation controller
void buildAnimation({
required Duration delay,
required bool animate,
Expand Down
73 changes: 49 additions & 24 deletions pubspec.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ packages:
dependency: transitive
description:
name: collection
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
sha256: a1ace0a119f20aabc852d165077c036cd864315bd99b7eaa10a60100341941bf
url: "https://pub.dev"
source: hosted
version: "1.18.0"
version: "1.19.0"
fake_async:
dependency: transitive
description:
Expand All @@ -59,51 +59,75 @@ packages:
description: flutter
source: sdk
version: "0.0.0"
leak_tracker:
dependency: transitive
description:
name: leak_tracker
sha256: "7bb2830ebd849694d1ec25bf1f44582d6ac531a57a365a803a6034ff751d2d06"
url: "https://pub.dev"
source: hosted
version: "10.0.7"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: "9491a714cca3667b60b5c420da8217e6de0d1ba7a5ec322fab01758f6998f379"
url: "https://pub.dev"
source: hosted
version: "3.0.8"
leak_tracker_testing:
dependency: transitive
description:
name: leak_tracker_testing
sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
url: "https://pub.dev"
source: hosted
version: "3.0.1"
matcher:
dependency: transitive
description:
name: matcher
sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
url: "https://pub.dev"
source: hosted
version: "0.12.16"
version: "0.12.16+1"
material_color_utilities:
dependency: transitive
description:
name: material_color_utilities
sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
url: "https://pub.dev"
source: hosted
version: "0.5.0"
version: "0.11.1"
meta:
dependency: transitive
description:
name: meta
sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
url: "https://pub.dev"
source: hosted
version: "1.10.0"
version: "1.15.0"
mocktail:
dependency: "direct dev"
description:
name: mocktail
sha256: c4b5007d91ca4f67256e720cb1b6d704e79a510183a12fa551021f652577dce6
sha256: "890df3f9688106f25755f26b1c60589a92b3ab91a22b8b224947ad041bf172d8"
url: "https://pub.dev"
source: hosted
version: "1.0.3"
version: "1.0.4"
path:
dependency: transitive
description:
name: path
sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
url: "https://pub.dev"
source: hosted
version: "1.8.3"
version: "1.9.0"
sky_engine:
dependency: transitive
description: flutter
source: sdk
version: "0.0.99"
version: "0.0.0"
source_span:
dependency: transitive
description:
Expand All @@ -116,10 +140,10 @@ packages:
dependency: transitive
description:
name: stack_trace
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
sha256: "9f47fd3630d76be3ab26f0ee06d213679aa425996925ff3feffdec504931c377"
url: "https://pub.dev"
source: hosted
version: "1.11.1"
version: "1.12.0"
stream_channel:
dependency: transitive
description:
Expand All @@ -132,10 +156,10 @@ packages:
dependency: transitive
description:
name: string_scanner
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
sha256: "688af5ed3402a4bde5b3a6c15fd768dbf2621a614950b17f04626c431ab3c4c3"
url: "https://pub.dev"
source: hosted
version: "1.2.0"
version: "1.3.0"
term_glyph:
dependency: transitive
description:
Expand All @@ -148,10 +172,10 @@ packages:
dependency: transitive
description:
name: test_api
sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
sha256: "664d3a9a64782fcdeb83ce9c6b39e78fd2971d4e37827b9b06c3aa1edc5e760c"
url: "https://pub.dev"
source: hosted
version: "0.6.1"
version: "0.7.3"
vector_math:
dependency: transitive
description:
Expand All @@ -160,13 +184,14 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.1.4"
web:
vm_service:
dependency: transitive
description:
name: web
sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
name: vm_service
sha256: f6be3ed8bd01289b34d679c2b62226f63c0e69f9fd2e50a6b3c1c729a961041b
url: "https://pub.dev"
source: hosted
version: "0.3.0"
version: "14.3.0"
sdks:
dart: ">=3.2.0-194.0.dev <4.0.0"
dart: ">=3.4.0 <4.0.0"
flutter: ">=3.18.0-18.0.pre.54"

0 comments on commit c4f736f

Please sign in to comment.