masamune_animate 3.1.2

A package for animation that runs on the Masamune framework.

Masamune Animate

---

[GitHub] | [YouTube] | [Packages] | [X] | [LinkedIn] | [mathru.net]

---

Masamune Animate

Usage

Overview

• Masamune Animate extends the Masamune framework with scenario-based animations.
• AnimateScope and AnimateController are the core APIs for building animation flows.
• Register AnimateMasamuneAdapter in MasamuneApp to enable the animation features.

Setup

1. Add masamune_animate to your project.

flutter pub add masamune_animate

2. Register AnimateMasamuneAdapter in MasamuneApp. You can configure the test timeout if needed.

// lib/adapter.dart

/// Masamune adapters used by the app.
final masamuneAdapters = <MasamuneAdapter>[
  const UniversalMasamuneAdapter(),
  
  const AnimateMasamuneAdapter(
    timeoutDurationOnTest: Duration(milliseconds: 300),  // Test timeout
  ),
];

3. Use in your main.dart:

void main() {
  runMasamuneApp(
    appRef: appRef,
    masamuneAdapters: masamuneAdapters,
    (appRef, _) => MasamuneApp(
      appRef: appRef,
      home: HomePage(),
    ),
  );
}

AnimateScope

• Requires either a controller or a scenario callback.
• autoPlay, repeat, repeatCount, and keys control when the animation plays and how the widget rebuilds.
• Use scenario for lightweight inline setups or supply an AnimateController when you need external triggers.

AnimateController

• Extends MasamuneControllerBase and implements AnimateRunner.
• Provide a scenario (async function) and call play() to run it; you can also enable automatic playback with autoPlay.
• The controller exposes primaryAdapter and isTest so you can adjust behavior when running under tests.

Basic Usage

Option 1: Using AnimateController (Recommended for reusable scenarios)

class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // Create controller with scenario
    final controller = AnimateController(
      autoPlay: true,
      scenario: (runner) async {
        await runner.fadeIn(duration: const Duration(milliseconds: 300));
        await runner.wait(const Duration(milliseconds: 200));
        await runner.moveY(
          duration: const Duration(milliseconds: 500),
          begin: -20,
          end: 0,
          curve: Curves.easeOut,
        );
      },
    );

    return AnimateScope(
      controller: controller,
      child: const Text("Masamune Animate"),
    );
  }
}

Option 2: Using inline scenario (For simple, one-time animations)

Widget build(BuildContext context) {
  return AnimateScope(
    autoPlay: true,
    scenario: (runner) async {
      await runner.fadeIn(duration: const Duration(milliseconds: 300));
      await runner.moveX(
        duration: const Duration(milliseconds: 500),
        begin: -50,
        end: 0,
      );
    },
    child: const Text("Hello World"),
  );
}

Option 3: Manual playback control

class MyWidget extends StatefulWidget {
  @override
  State<MyWidget> createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> with TickerProviderStateMixin {
  late final AnimateController controller;

  @override
  void initState() {
    super.initState();
    controller = AnimateController(
      scenario: (runner) async {
        await runner.fadeIn(duration: const Duration(milliseconds: 300));
      },
    );
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      children: [
        AnimateScope(
          controller: controller,
          child: const Text("Animated Text"),
        ),
        ElevatedButton(
          onPressed: () => controller.play(),  // Manual trigger
          child: const Text("Play Animation"),
        ),
      ],
    );
  }
}

Built-in Queries

• Opacity: opacity, fadeIn, fadeOut
• Movement: move, moveX, moveY
• Rotation: rotate
• Scale: scale, scaleX, scaleY, scaleXY
• Color filter: color
• Custom values: custom
• Delay: wait

Each helper is defined as an AnimateRunner extension, so you can await calls sequentially to build a scenario.

Testing Tips

• In test mode (AnimateMasamuneAdapter.isTest == true), repeat playback is disabled and TickerMode is set to false to avoid unnecessary frames.
• Keep waits inside scenarios within the configured timeoutDurationOnTest to prevent test hangs.

Operations

• Follow the project rules for managing adapters in lib/adapter.dart by listing them inside the masamuneAdapters collection.
• When updating UI affected by animations, run katana test update and katana test run to refresh golden images and verify behavior.

GitHub Sponsors

Sponsors are always welcome. Thank you for your support!

https://github.com/sponsors/mathrunet