Payload is now optional when calling from Javascript. Renamed bottom modal to bottom sheet

Author: vusters

lib/action/action_invokable.dart

@@ -24,18 +24,23 @@ abstract class ActionInvokable with Invokable {
       ActionType.getPhoneContactPhoto,
       ActionType.showBottomModal,
       ActionType.dismissBottomModal,
+      ActionType.showBottomSheet,
+      ActionType.dismissBottomSheet,
       ActionType.showDialog,
       ActionType.navigateViewGroup,
+      ActionType.showToast,
     ]);
   }
 
   Map<String, Function> _generateFromActionTypes(List<ActionType> actionTypes) {
     Map<String, Function> functions = {};
     for (ActionType actionType in actionTypes) {
-      functions[actionType.name] = (payload) {
+      functions[actionType.name] = ([dynamic payload]) {
+        // payload is optional but must be a Map if specified
         if (payload != null && payload is! Map) {
           throw LanguageError("${actionType.name} has an invalid payload.");
         }
+
         EnsembleAction? action =
             EnsembleAction.fromActionType(actionType, payload: payload);
         return action?.execute(buildContext, _getScopeManager(buildContext));

lib/action/bottom_modal_actions.dart renamed to lib/action/bottom_sheet_actions.dart

@@ -11,8 +11,8 @@ import 'package:ensemble_ts_interpreter/invokables/invokable.dart';
 import 'package:flutter/material.dart';
 
 /// open a Modal Bottom Sheet
-class ShowBottomModalAction extends EnsembleAction {
-  ShowBottomModalAction({
+class ShowBottomSheetAction extends EnsembleAction {
+  ShowBottomSheetAction({
     super.initiator,
     super.inputs,
     required this.body,
@@ -26,13 +26,13 @@ class ShowBottomModalAction extends EnsembleAction {
   final dynamic body;
   final EnsembleAction? onDismiss;
 
-  factory ShowBottomModalAction.from({Invokable? initiator, Map? payload}) {
+  factory ShowBottomSheetAction.from({Invokable? initiator, Map? payload}) {
     dynamic body = payload?['body'] ?? payload?['widget'];
     if (payload == null || body == null) {
       throw LanguageError(
-          "${ActionType.showBottomModal.name} requires a body widget.");
+          "${ActionType.showBottomSheet.name} requires a body widget.");
     }
-    return ShowBottomModalAction(
+    return ShowBottomSheetAction(
         initiator: initiator,
         inputs: Utils.getMap(payload['inputs']),
         body: body,
@@ -104,7 +104,7 @@ class ShowBottomModalAction extends EnsembleAction {
               bottom: MediaQuery.of(modalContext).viewInsets.bottom,
             ),
             // have a bottom modal scope widget so we can close the modal
-            child: BottomModalScopeWidget(
+            child: BottomSheetScopeWidget(
               rootContext: modalContext,
               // create a new Data Scope since the bottom modal is placed in a different context tree (directly under MaterialApp)
               child: DataScopeWidget(
@@ -139,6 +139,9 @@ class ShowBottomModalAction extends EnsembleAction {
         initialViewport = (minViewport + maxViewport) / 2.0;
       }
 
+      // On platforms with a mouse (Web/desktop), there is no min/maxViewport due to platform consistency,
+      // so the height will be fixed to initialViewport, and content will just scroll within it.
+      // https://docs.flutter.dev/release/breaking-changes/default-scroll-behavior-drag
       return DraggableScrollableSheet(
           expand: false,
           minChildSize: minViewport,
@@ -168,8 +171,8 @@ class ShowBottomModalAction extends EnsembleAction {
                     topLeft: defaultTopBorderRadius,
                     topRight: defaultTopBorderRadius)),
         clipBehavior: Clip.antiAlias,
+        // stretch width 100%. Note that Flutter's bottom sheet has a width constraint on Web/Desktop so it may not take 100% on wide screen
         width: double.infinity,
-        // stretch width 100%
         child: useSafeArea(scopeManager) ? SafeArea(child: child) : child);
     if (showDragHandle(scopeManager)) {
       rootWidget = Stack(
@@ -194,43 +197,43 @@ class ShowBottomModalAction extends EnsembleAction {
 }
 
 /// Dismiss the Bottom Modal (if the context is a descendant, no-op otherwise)
-class DismissBottomModalAction extends EnsembleAction {
-  DismissBottomModalAction({this.payload});
+class DismissBottomSheetAction extends EnsembleAction {
+  DismissBottomSheetAction({this.payload});
 
   Map? payload;
 
-  factory DismissBottomModalAction.from({Map? payload}) =>
-      DismissBottomModalAction(payload: payload?['payload']);
+  factory DismissBottomSheetAction.from({Map? payload}) =>
+      DismissBottomSheetAction(payload: payload?['payload']);
 
   @override
   Future<dynamic> execute(BuildContext context, ScopeManager scopeManager,
       {DataContext? dataContext}) {
-    BuildContext? bottomModalContext =
-        BottomModalScopeWidget.getRootContext(context);
-    if (bottomModalContext != null) {
+    BuildContext? bottomSheetContext =
+        BottomSheetScopeWidget.getRootContext(context);
+    if (bottomSheetContext != null) {
       return Navigator.maybePop(
-          bottomModalContext, scopeManager.dataContext.eval(payload));
+          bottomSheetContext, scopeManager.dataContext.eval(payload));
     }
     return Navigator.maybePop(context, scopeManager.dataContext.eval(payload));
   }
 }
 
-/// a wrapper InheritedWidget for its descendant to look up the root modal context to close it
-class BottomModalScopeWidget extends InheritedWidget {
-  const BottomModalScopeWidget(
+/// a wrapper InheritedWidget for its descendant to look up the Sheet's root context to close it
+class BottomSheetScopeWidget extends InheritedWidget {
+  const BottomSheetScopeWidget(
       {super.key, required super.child, required this.rootContext});
 
   // this is the context root of the modal
   final BuildContext rootContext;
 
   @override
-  bool updateShouldNotify(covariant BottomModalScopeWidget oldWidget) {
+  bool updateShouldNotify(covariant BottomSheetScopeWidget oldWidget) {
     return oldWidget.rootContext != rootContext;
   }
 
   static BuildContext? getRootContext(BuildContext context) {
-    BottomModalScopeWidget? wrapperWidget =
-        context.dependOnInheritedWidgetOfExactType<BottomModalScopeWidget>();
+    BottomSheetScopeWidget? wrapperWidget =
+        context.dependOnInheritedWidgetOfExactType<BottomSheetScopeWidget>();
     return wrapperWidget?.rootContext;
   }
 }

lib/framework/action.dart

@@ -2,7 +2,7 @@ import 'package:app_settings/app_settings.dart';
 import 'package:ensemble/action/audio_player.dart';
 import 'package:ensemble/action/Log_event_action.dart';
 import 'package:ensemble/action/badge_action.dart';
-import 'package:ensemble/action/bottom_modal_actions.dart';
+import 'package:ensemble/action/bottom_sheet_actions.dart';
 import 'package:ensemble/action/deep_link_action.dart';
 import 'package:ensemble/action/call_external_method.dart';
 import 'package:ensemble/action/haptic_action.dart';
@@ -1085,7 +1085,11 @@ enum ActionType {
   navigateViewGroup,
   navigateExternalScreen,
   navigateModalScreen,
+  showBottomSheet,
+  dismissBottomSheet,
+  @Deprecated("use showBottomSheet")
   showBottomModal,
+  @Deprecated("use dismissBottomSheet")
   dismissBottomModal,
   showDialog,
   startTimer,
@@ -1202,10 +1206,12 @@ abstract class EnsembleAction {
           initiator: initiator, payload: payload);
     } else if (actionType == ActionType.navigateBack) {
       return NavigateBackAction.from(payload: payload);
-    } else if (actionType == ActionType.showBottomModal) {
-      return ShowBottomModalAction.from(payload: payload);
-    } else if (actionType == ActionType.dismissBottomModal) {
-      return DismissBottomModalAction.from(payload: payload);
+    } else if (actionType == ActionType.showBottomSheet ||
+        actionType == ActionType.showBottomModal) {
+      return ShowBottomSheetAction.from(payload: payload);
+    } else if (actionType == ActionType.dismissBottomSheet ||
+        actionType == ActionType.dismissBottomModal) {
+      return DismissBottomSheetAction.from(payload: payload);
     } else if (actionType == ActionType.invokeAPI) {
       return InvokeAPIAction.fromYaml(initiator: initiator, payload: payload);
     } else if (actionType == ActionType.openCamera) {

lib/framework/data_context.dart

@@ -5,7 +5,7 @@ import 'dart:ui';
 import 'package:ensemble/action/Log_event_action.dart';
 import 'package:ensemble/action/action_invokable.dart';
 import 'package:ensemble/action/audio_player.dart';
-import 'package:ensemble/action/bottom_modal_actions.dart';
+import 'package:ensemble/action/bottom_sheet_actions.dart';
 import 'package:ensemble/action/haptic_action.dart';
 import 'package:ensemble/action/invoke_api_action.dart';
 import 'package:ensemble/action/misc_action.dart';
@@ -473,8 +473,6 @@ class NativeInvokable extends ActionInvokable {
       ActionType.stopTimer.name: stopTimer,
       ActionType.openCamera.name: showCamera,
       ActionType.navigateBack.name: navigateBack,
-      ActionType.showToast.name: (inputs) => ScreenController()
-          .executeAction(buildContext, ShowToastAction.fromMap(inputs)),
       ActionType.startTimer.name: (inputs) => ScreenController()
           .executeAction(buildContext, StartTimerAction.fromMap(inputs)),
       ActionType.uploadFiles.name: uploadFiles,
@@ -503,16 +501,6 @@ class NativeInvokable extends ActionInvokable {
         final scope = ScreenController().getScopeManager(buildContext);
         callNativeMethod(buildContext, scope, inputs);
       },
-      ActionType.showBottomModal.name: (inputs) =>
-          ScreenController().executeAction(
-            buildContext,
-            ShowBottomModalAction.from(payload: inputs),
-          ),
-      ActionType.dismissBottomModal.name: (inputs) =>
-          ScreenController().executeAction(
-            buildContext,
-            DismissBottomModalAction.from(payload: inputs),
-          ),
       ActionType.showDialog.name: (inputs) => ScreenController()
           .executeAction(buildContext, ShowDialogAction.from(payload: inputs)),
       ActionType.rateApp.name: (inputs) => ScreenController()