🔧 Update Pack 2 #25

Author: SaadArdati

CHANGELOG.md

@@ -1,58 +1,108 @@
-## 0.3.0
-
-- Added Padding effect & a global roll effect.
-- BREAKING: Effect apply function's child parameter is now nullable.
-- BREAKING: Text rolling API has been changed to be more in-line with other effects.
-- BREAKING: `startImmediately` has been replaced with `startState`.
-- Fixed default state of blur effect was in a blur state instead of an unblurred state.
-- Added more variables to the scroll transition's events.
-- Added `usePointerRouter` to pointer transition to determine whether to use the Flutter global pointer router or a
-  GestureDetector.
-- Add `resetValues`, `interruptable`, `skipIf`, and `startState` properties to AnimatedEffect.
-- Add `transformHits` property to translate effect.
-- Add `rotateIn` and `rotateOut` to the rotate effect.
-- Add width & height factor to align effect.
-- Add characterTapeBuilders to `SymbolTapeStrategy` class for custom tape builders.
-
-## 0.2.3
-
-- Fix dart analysis issues.
-
-## 0.2.2
-
-- Clamp `OpacityEffect`, `ClipEffect`, and `ColorFilterEffect` values to 0.0 - 1.0 to prevent exceptions with
-  curves that go outside of this range.
-- Add new `startImmediately` boolean to .animate() to allow for animations to start immediately without waiting for an
-  initial change in the `trigger` object.
-- Improve documentation of `AnimatedEffect`.
-
-## 0.2.1
-
-- Fix exceptions being thrown when animation controller state is changed before completion.
-
-## 0.2.0
-
-- [BREAKING] Renamed `toggle` to `trigger` in .animate() to better reflect its purpose.
-- [BREAKING] Renamed `AnimatedEffect` to `EffectWidget` to better reflect its purpose.
-- [BREAKING] Renamed `EffectAnimationValue` to `EffectQuery` to better reflect its purpose.
-- [BREAKING] Replace `value` in `EffectQuery` with `linearValue` and `curvedValue` to allow more refined control over
-  animations.
-- [BREAKING] Renamed `PostFrameWidget` to `PostFrame`.
-- Add new Rolling Text effect.
-- Add new shake effect.
-- Add new align effect.
-- Update all effect extension functions to add more functionality of the `from` state.
-- Add new extension functions that have default from states like slideIn/Out() and fadeIn/Out().
-- Add new `oneShot`, `animateAfter`, `resetAll` functions to allow for more control over animations.
-- Add new `repeat` parameter to animation functions to allow for repeating animations.
-- Add new `delay` parameter to animation functions to allow for delaying animations.
-- Add new `playIf` parameter to animation functions to allow for conditional animations.
-
-## 0.1.1
-
-- Minor doc updates.
-- Add example GIFs in readme.
-
-## 0.1.0
-
-- Initial Release.
+# Changelog
+
+All notable changes to the Hyper Effects package are documented in this file.
+
+## [0.3.0] - Dec 15, 2024
+
+### Added
+- **New Effects**
+  - Padding effect for dynamic padding adjustments.
+  - Global roll effect for universal rolling animations.
+  - Width & height factor support in align effect.
+- **Scroll Transition Enhancements**
+  - Additional event variables for finer control.
+  - Improved transition state management.
+- **Pointer Transition Features**
+  - `usePointerRouter` option for flexible pointer event handling.
+  - Enhanced pointer position tracking.
+- **New AnimatedEffect Properties**
+  - `resetValues` - Controls value reset behavior.
+  - `interruptable` - Manages animation interruption.
+  - `skipIf` - Conditional animation execution.
+  - `startState` - Initial animation state control.
+  - `transformHits` property for translate effect.
+  - `rotateIn` and `rotateOut` methods for rotate effect.
+- **Added New Examples**
+  - group_animation.dart
+  - rolling_app_bar_animation.dart
+  - rolling_pictures_animation.dart
+  - scroll_phase_slide.dart
+  - scroll_phase_blur.dart
+  - success_card_animation.dart
+
+### Changed
+- **Breaking Changes**
+  - Effect apply function's child parameter is now nullable.
+  - Text rolling API redesigned for consistency with other effects.
+    - New unified interface matching other animation effects.
+    - Previous text rolling methods have been deprecated.
+  - `startImmediately` replaced with more flexible `startState`.
+  - Removed unnecessary PostFrame callbacks from pointer transition logic.
+- **Improvements**
+  - Default blur effect state now starts un-blurred.
+  - Added `characterTapeBuilders` to `SymbolTapeStrategy` for customization.
+  - Fixed issues with scroll transitions to provide smoother and more consistent user experience.
+
+## [0.2.3] - Feb 2, 2024
+
+### Fixed
+- Resolved Dart analysis issues for better code quality
+
+## [0.2.2] - Feb 2, 2024
+
+### Added
+- New `startImmediately` boolean in .animate()
+- Improved documentation for `AnimatedEffect`
+
+### Fixed
+- Value clamping for:
+  - `OpacityEffect` (0.0 - 1.0)
+  - `ClipEffect` (0.0 - 1.0)
+  - `ColorFilterEffect` (0.0 - 1.0)
+- Prevents exceptions with out-of-range curves
+
+## [0.2.1] - Dec 28, 2023
+
+### Fixed
+- Animation controller state change exception handling
+
+## [0.2.0] - Dec 24, 2023
+
+### Added
+- **New Effects**
+  - Rolling Text effect for text animations
+  - Shake effect for vibration animations
+  - Align effect for alignment control
+- **Animation Control**
+  - `oneShot` function for immediate animations
+  - `animateAfter` for sequential animations
+  - `resetAll` for animation state reset
+  - Repeat parameter for cyclic animations
+  - Delay parameter for timed starts
+  - `playIf` for conditional execution
+
+### Changed
+- **Breaking Changes**
+  - Renamed:
+    - `toggle` → `trigger` in .animate()
+    - `AnimatedEffect` → `EffectWidget`
+    - `EffectAnimationValue` → `EffectQuery`
+    - `PostFrameWidget` → `PostFrame`
+  - Enhanced `EffectQuery` with `linearValue` and `curvedValue`
+- **Improvements**
+  - Updated effect extensions with `from` state support
+  - Added convenience methods (slideIn/Out, fadeIn/Out)
+
+## [0.1.1] - Oct 26, 2023
+
+### Changed
+- Documentation improvements
+- Added example GIFs in README
+
+## [0.1.0] - Oct 25, 2023
+
+### Added
+- Initial release of Hyper Effects
+- Core animation and effect system
+- Basic effect implementations
+- Documentation and examples

README.md

@@ -299,14 +299,16 @@ This is what the Widget tree looks like internally when you use this library.
 * delay: A delay before the animation starts.
 * playIf: A callback that returns whether the animation should be played or skipped. If the callback returns false, the
   animation will be skipped, even when it is explicitly triggered.
-* resetValues:  Normally, an effect represents the current state of the widget and this
+* resetValues: Normally, an effect represents the current state of the widget and this
   animate effect is only in charge of lerping between states of those effect values.
   If this is set to true, instead of treating effects as current states to animate between, it will always animate from
   an initial default state towards the current state.
 * interruptable: Whether the animation should be reset on subsequent triggers. If this animation is re-triggered, it
   will reset the current active animation and re-drive from the beginning.
   Setting this to true will force the animation to wait for the last animation in the chain to finish before starting.
 * startState: Determines the behavior of the animation as soon as it is added to the widget tree.
+* skipIf: A callback that determines whether the animation should be skipped. If the callback returns true, the animation
+  will be skipped entirely.
 
 ### One Shot Animations
 
@@ -466,6 +468,23 @@ Widget build(BuildContext context) {
 In this example, the text will roll from 'Hello' to 'World'. Each character in 'Hello' will roll until it changes to the
 corresponding character in 'World'.
 
+For non-text widgets, you can use the roll effect similarly:
+
+```dart
+@override
+Widget build(BuildContext context) {
+  return Container(
+    width: 100,
+    height: 100,
+    color: Colors.blue,
+  ).roll(
+    from: const Offset(0, 0),
+    to: const Offset(0, 100),
+    axis: Axis.vertical,
+  );
+}
+```
+
 #### Customization
 
 The Rolling Text feature provides several options for customization:
@@ -487,6 +506,14 @@ The Rolling Text feature provides several options for customization:
   provided to the `animate` function.
 - widthCurve: Determines the curve of the width animation of each tape. If null, the same curve is used as the one
   provided to the `animate` function.
+- characterTapeBuilders: Custom builders for individual character tapes, allowing for fine-grained control over how each
+  character is displayed and animated.
+
+For the general roll effect, additional options include:
+- axis: The axis along which the rolling animation occurs (horizontal or vertical).
+- from: The starting offset or state.
+- to: The ending offset or state.
+- transformHits: Whether hit testing should be transformed with the roll animation.
 
 Here's an example of how to use these options:
 

example/.gitignore

@@ -5,9 +5,11 @@
 *.swp
 .DS_Store
 .atom/
+.build/
 .buildlog/
 .history
 .svn/
+.swiftpm/
 migrate_working_dir/
 
 # IntelliJ related

example/.metadata

@@ -4,7 +4,7 @@
 # This file should be version controlled and should not be manually edited.
 
 version:
-  revision: "ead455963c12b453cdb2358cad34969c76daf180"
+  revision: "8495dee1fd4aacbe9de707e7581203232f591b2f"
   channel: "stable"
 
 project_type: app
@@ -13,14 +13,11 @@ project_type: app
 migration:
   platforms:
     - platform: root
-      create_revision: ead455963c12b453cdb2358cad34969c76daf180
-      base_revision: ead455963c12b453cdb2358cad34969c76daf180
+      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
     - platform: macos
-      create_revision: ead455963c12b453cdb2358cad34969c76daf180
-      base_revision: ead455963c12b453cdb2358cad34969c76daf180
-    - platform: web
-      create_revision: ead455963c12b453cdb2358cad34969c76daf180
-      base_revision: ead455963c12b453cdb2358cad34969c76daf180
+      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
 
   # User provided section
 

example/lib/main.dart

@@ -11,8 +11,8 @@ import 'package:hyper_effects_demo/stories/group_animation.dart';
 import 'package:hyper_effects_demo/stories/one_shot_reset_animation.dart';
 import 'package:hyper_effects_demo/stories/rolling_app_bar_animation.dart';
 import 'package:hyper_effects_demo/stories/rolling_pictures_animation.dart';
-import 'package:hyper_effects_demo/stories/scroll_phase_slide.dart';
 import 'package:hyper_effects_demo/stories/scroll_phase_blur.dart';
+import 'package:hyper_effects_demo/stories/scroll_phase_slide.dart';
 import 'package:hyper_effects_demo/stories/scroll_wheel_transition.dart';
 import 'package:hyper_effects_demo/stories/shake_and_spring_animation.dart';
 import 'package:hyper_effects_demo/stories/success_card_animation.dart';
@@ -84,10 +84,7 @@ class Storyboard extends StatefulWidget {
 
 class _StoryboardState extends State<Storyboard> with WidgetsBindingObserver {
   final List<Story> animationStories = [
-    const Story(
-      title: 'Success Card Animation',
-      child: SuccessCardAnimation()
-    ),
+    const Story(title: 'Success Card Animation', child: SuccessCardAnimation()),
     const Story(
       title: 'Group Animation',
       child: GroupAnimation(),