push static method

Future<void> push({
  1. required BuildContext context,
  2. required HeroContainerController controller,
  3. Color? openedColor,
  4. Color? closedColor,
  5. ShapeBorder? openedShape,
  6. ShapeBorder? closedShape,
  7. required double openedElevation,
  8. required double closedElevation,
  9. required BoxFit openedFit,
  10. required BoxFit closedFit,
  11. required AlignmentGeometry openedAlignemnt,
  12. required AlignmentGeometry closedAlignment,
  13. required Duration transitionDuration,
  14. required Curve transitionCurve,
  15. HeroContianerClosedCallback? onClosed,
  16. HeroContianerFlightShuttleBuilder? flightShuttleBuilder,
})

Launches a hero container transition.

Captures the current widget state and pushes a HeroContainerRoute with the specified transition properties. The route handles the animation between the captured snapshots.

Implementation

static Future<void> push({
  required BuildContext context,
  required HeroContainerController controller,
  Color? openedColor,
  Color? closedColor,
  ShapeBorder? openedShape,
  ShapeBorder? closedShape,
  required double openedElevation,
  required double closedElevation,
  required BoxFit openedFit,
  required BoxFit closedFit,
  required AlignmentGeometry openedAlignemnt,
  required AlignmentGeometry closedAlignment,
  required Duration transitionDuration,
  required Curve transitionCurve,
  HeroContianerClosedCallback? onClosed,
  HeroContianerFlightShuttleBuilder? flightShuttleBuilder,
}) async {
  // Capture the initial widget state before transition.
  controller.fromFragment = await controller.fragmentOf(
    context,
    controller.fromKey,
  );

  if (context.mounted) {
    await Navigator.push(
      context,
      HeroContainerRoute(
        openedColor: openedColor,
        closedColor: closedColor,
        openedShape: openedShape,
        closedShape: closedShape,
        openedElevation: openedElevation,
        closedElevation: closedElevation,
        openedFit: openedFit,
        closedFit: closedFit,
        openedAlignemnt: openedAlignemnt,
        closedAlignment: closedAlignment,
        transitionDuration: transitionDuration,
        transitionCurve: transitionCurve,
        heroController: controller,
        onClosed: onClosed,
        flightShuttleBuilder:
            flightShuttleBuilder ?? _defaultFlightShuttleBuilder,
      ),
    );
  }
}