celebrateWithMessage static method

void celebrateWithMessage(
  1. BuildContext context, {
  2. required String message,
  3. Preset preset = Preset.nova,
  4. CelebrationScene? scene,
  5. ConfettiShowcase? showcase,
  6. bool enableHaptics = true,
  7. bool enableSound = false,
  8. String? soundAssetPath,
  9. CelebrationFeedback? feedback,
  10. List<String>? emojiPool,
  11. ConfettiCustomization? customization,
  12. TextStyle? messageStyle,
  13. Alignment messageAlignment = Alignment.bottomCenter,
  14. EdgeInsets messageOuterPadding = const EdgeInsets.fromLTRB(24, 0, 24, 56),
  15. TextAlign messageTextAlign = TextAlign.center,
  16. BoxDecoration? messageDecoration,
  17. EdgeInsets messageInnerPadding = const EdgeInsets.symmetric(horizontal: 16, vertical: 10),
  18. int? durationInSeconds,
  19. bool showMessage = true,
  20. VoidCallback? onComplete,
})

Full-screen confetti plus an optional styled banner message.

Prefer celebrate with CelebrationMessageOptions for full control. Touches pass through the overlay (including the label).

Implementation

static void celebrateWithMessage(
  BuildContext context, {
  required String message,
  Preset preset = Preset.nova,
  CelebrationScene? scene,
  ConfettiShowcase? showcase,
  bool enableHaptics = true,
  bool enableSound = false,
  String? soundAssetPath,
  CelebrationFeedback? feedback,
  List<String>? emojiPool,
  ConfettiCustomization? customization,
  TextStyle? messageStyle,
  Alignment messageAlignment = Alignment.bottomCenter,
  EdgeInsets messageOuterPadding = const EdgeInsets.fromLTRB(24, 0, 24, 56),
  TextAlign messageTextAlign = TextAlign.center,
  BoxDecoration? messageDecoration,
  EdgeInsets messageInnerPadding =
      const EdgeInsets.symmetric(horizontal: 16, vertical: 10),
  int? durationInSeconds,
  bool showMessage = true,
  VoidCallback? onComplete,
}) {
  celebrate(
    context,
    preset: preset,
    scene: scene,
    showcase: showcase,
    enableHaptics: enableHaptics,
    enableSound: enableSound,
    soundAssetPath: soundAssetPath,
    feedback: feedback,
    emojiPool: emojiPool,
    customization: customization,
    overlayMessage: CelebrationMessageOptions(
      message: message,
      showMessage: showMessage,
      alignment: messageAlignment,
      outerPadding: messageOuterPadding,
      textAlign: messageTextAlign,
      style: messageStyle,
      decoration: messageDecoration,
      innerPadding: messageInnerPadding,
      durationInSeconds: durationInSeconds,
    ),
    onComplete: onComplete,
  );
}