showAttach<T> static method

attach dialog

targetContext：BuildContext with target widget

builder：the custom dialog

replaceBuilder：The widget returned in replaceBuilder will replace the widget returned in builder; replaceBuilder will callback the offset and size of the target widget and the offset and size of the dialog itself. You can customize a suitable replacement widget according to these parameters. It is strongly recommended that the width and height of the custom widget returned by replaceBuilder should be consistent with that in builder, and the positioning information in showAttach is calculated based on the widget in builder.

controller：this controller can be used to refresh the layout of the custom dialog

targetBuilder：Manually specify the appropriate coordinate point. When targetBuilder is used, the targetContext param will not be able to automatically set the position. The param of the targetBuilder callback are calculated according to the targetContext

alignment：control the location of the dialog, For details, please refer to the description of alignment parameters in SmartConfigAttach

clickMaskDismiss：true（the dialog will be closed after click mask），false（not close）

animationType：Set the animation type, For details, please refer to the SmartAnimationType comment

nonAnimationTypes：For different scenes, the pop-up animation can be dynamically closed. For details, please refer to SmartNonAnimationType

animationBuilder：Support highly custom animation, please refer to AnimationBuilder description for details

scalePointBuilder：he zoom point of the zoom animation, the default point is the center point of the attach widget as the zoom point; Offset(0, 0): Use the upper left point of the control as the zoom point, Offset(attach widget width, 0): Use the upper right point of the control as the zoom point Offset(0, attach widget height): use the lower left point of the control as the zoom point, Offset (attach widget width, attach widget height): use the lower right point of the control as the zoom point

usePenetrate：true（the click event will penetrate mask），false（not penetration）

useAnimation：true（use the animation），false（not use）

animationTime：animation duration

maskColor：the color of the mask，it is invalid if maskWidget set the value and usePenetrate is true

maskWidget：highly customizable mask

maskIgnoreArea：mask occupancy ignore area, support up, down, left and right areas, set area, mask will not occupy space in this area; Example: maskIgnoreArea: Rect.fromLTRB (0,0,0,30), there will be 30 gaps at the bottom, the mask will not occupy this area; Applies to: do not want mask to cover navigation bar areas such as BottomNavigationBar, NavigationRail

onMask：this callback will be triggered when the mask is clicked

debounce：debounce feature

highlightBuilder：highlight function, dissolve the mask of a specific area, you can quickly get the target widget information (coordinates and size)

onDismiss：the callback will be invoked when the dialog is closed

displayTime：Controls the display time of the dialog on the screen; the default is null, if it is null, it means that the param will not control the dialog to close; note: Using the displayTime param will disable the use of the tag param

tag：if you set a tag for the dialog, you can turn it off in a targeted manner

backDismiss：true（the back event will close the dialog but not close the page）， false（the back event not close the dialog and not close page），you still can use the dismiss method to close the dialog

keepSingle：default (false), true (calling showAttach multiple times will not generate multiple dialogs, only single dialog will be kept), false (calling showAttach multiple times will generate multiple dialogs)

permanent：default (false), true (set the dialog as a permanent dialog), false (not set); Various security operations (return events, routing) inside the framework cannot close the permanent dialog, you need to close this kind of dialog: dismiss(force: true)

useSystem：default (false), true (using the system dialog, usePenetrate is invalid; tag, keepSingle and permanent are prohibited), false (using SmartDialog), using this param can make SmartDialog reasonably interact with the routing page and the dialog that comes with flutter

bindPage：bind the dialog to the current page, the bound page is not on the top of the stack, the dialog is automatically hidden, the bound page is placed on the top of the stack, and the dialog is automatically displayed; the bound page is closed, and the dialog bound to the page will also be removed

bindWidget：bind the dialog to a Widget, when the widget is not visible, the dialog is automatically hidden, and when the widget is visible, the dialog is automatically displayed; Applicable to PageView, TabView, etc., bind its sub-pages, and when switching pages, the dialog can also interact reasonably Note: The processing logic of bindWidget takes precedence over bindPage. When bindWidget is not null, bindPage will be automatically set to false.

定位弹窗

targetContext：伴随位置widget的BuildContext

builder：自定义 dialog

replaceBuilder：replaceBuilder中返回widget会替换掉builder中返回的widget; replaceBuilder将回调目标widget的坐标,大小和dialog自身的坐标,大小,你可以根据这些参数,重新自定义一个合适的替换widget, 强烈建议replaceBuilder返回的自定义的widget宽高和builder中的保持一致, showAttach中定位信息都是根据builder中widget计算得来的

controller：可使用该控制器来刷新自定义的dialog的布局

targetBuilder：手动指定合适坐标点，当targetBuilder被使用时，targetContext参数将无法自动设置位置, targetBuilder回调的参数是根据targetContext计算得来的

alignment：控制弹窗的位置, 详细请参照SmartConfigAttach中alignment参数说明

clickMaskDismiss：true（点击遮罩后，将关闭dialog），false（不关闭）

animationType：具体可参照SmartAnimationType注释

nonAnimationTypes：对于不同的场景, 可动态关闭弹窗动画, 具体请参照SmartNonAnimationType

animationBuilder：支持高度自定义动画, 具体可参照AnimationBuilder说明

scalePointBuilder：缩放动画的缩放点, 默认点将自定义dialog控件的中心点作为缩放点; Offset(0, 0): 将控件左上点作为缩放点, Offset(控件宽度, 0): 将控件右上点作为缩放点 Offset(0, 控件高度): 将控件左下点作为缩放点, Offset(控件宽度, 控件高度): 将控件右下点作为缩放点

usePenetrate：true（点击事件将穿透遮罩），false（不穿透）

useAnimation：true（使用动画），false（不使用）

animationTime：动画持续时间

maskColor：遮罩颜色，如果给maskWidget设置了值，该参数将会失效

maskWidget：可高度定制遮罩

maskIgnoreArea：mask占位忽略区域, 支持上下左右区域, 设置的区域, mask将不会在此区域占位; 例: maskIgnoreArea: Rect.fromLTRB(0, 0, 0, 30), 底部会有30空隙, mask不会占位该区域; 适用于: 不想mask覆盖BottomNavigationBar, NavigationRail之类的导航栏区域

onMask：点击遮罩时，该回调将会被触发

debounce：防抖功能

highlightBuilder：高亮功能，溶解特定区域的遮罩，可以快速获取目标widget信息（坐标和大小）

onDismiss：在dialog被关闭的时候，该回调将会被触发

displayTime：控制弹窗在屏幕上显示时间; 默认为null, 为null则代表该参数不会控制弹窗关闭; 注: 使用displayTime参数, 将禁止使用tag参数

tag：如果你给dialog设置了tag, 你可以针对性的关闭它

backDismiss：true（返回事件将关闭dialog，但是不会关闭页面）， false（返回事件不会关闭loading，也不会关闭页面），你仍然可以使用dismiss方法来关闭dialog

keepSingle：默认（false），true（多次调用showAttach并不会生成多个dialog，仅仅保持一个dialog）， false（多次调用showAttach会生成多个dialog）

permanent：默认（false），true（将该dialog设置为永久化dialog）,false(不设置); 框架内部各种兜底操作(返回事件,路由)无法关闭永久化dialog, 需要关闭此类dialog可使用: dismiss(force: true)

useSystem：默认（false），true（使用系统dialog，usePenetrate功能失效; tag, keepSingle和permanent禁止使用）， false（使用SmartDialog），使用该参数可使SmartDialog, 与路由页面以及flutter自带dialog合理交互

bindPage：将该dialog与当前页面绑定，绑定页面不在路由栈顶，dialog自动隐藏，绑定页面置于路由栈顶，dialog自动显示; 绑定页面被关闭,被绑定在该页面上的dialog也将被移除

bindWidget：将dialog与某个Widget绑定, 当该widget不可见时, dialog自动隐藏, 该widget可见时, dialog自动显示; 适用于PageView, TabView之类, 绑定其子页面, 切换页面时, dialog也能合理交互 注意: bindWidget处理路由逻辑高于bindPage, 当bindWidget不为null, bindPage将自动被设置为false

static Future<T?> showAttach<T>({
  required BuildContext? targetContext,
  required WidgetBuilder builder,
  ReplaceBuilder? replaceBuilder,
  SmartDialogController? controller,
  TargetBuilder? targetBuilder,
  Alignment? alignment,
  bool? clickMaskDismiss,
  SmartAnimationType? animationType,
  List<SmartNonAnimationType>? nonAnimationTypes,
  AnimationBuilder? animationBuilder,
  ScalePointBuilder? scalePointBuilder,
  bool? usePenetrate,
  bool? useAnimation,
  Duration? animationTime,
  Color? maskColor,
  Widget? maskWidget,
  Rect? maskIgnoreArea,
  VoidCallback? onMask,
  bool? debounce,
  HighlightBuilder? highlightBuilder,
  VoidCallback? onDismiss,
  Duration? displayTime,
  String? tag,
  bool? backDismiss,
  bool? keepSingle,
  bool? permanent,
  bool? useSystem,
  bool? bindPage,
  BuildContext? bindWidget,
}) {
  assert(
    targetContext != null || targetBuilder != null,
    'targetContext and target, cannot both be null',
  );
  assert(
    (useSystem == true &&
            tag == null &&
            permanent == null &&
            keepSingle == null) ||
        (useSystem == null || useSystem == false),
    'useSystem is true; tag, keepSingle and permanent prohibit setting values',
  );

  return DialogProxy.instance.showAttach<T>(
    targetContext: targetContext,
    widget: DialogScope(
      controller: controller,
      builder: (context) => builder(context),
    ),
    targetBuilder: targetBuilder,
    replaceBuilder: replaceBuilder,
    alignment: alignment ?? config.attach.alignment,
    clickMaskDismiss: clickMaskDismiss ?? config.attach.clickMaskDismiss,
    animationType: animationType ?? config.attach.animationType,
    nonAnimationTypes: nonAnimationTypes ?? config.attach.nonAnimationTypes,
    animationBuilder: animationBuilder,
    scalePointBuilder: scalePointBuilder,
    usePenetrate: usePenetrate ?? config.attach.usePenetrate,
    useAnimation: useAnimation ?? config.attach.useAnimation,
    animationTime: animationTime ?? config.attach.animationTime,
    maskColor: maskColor ?? config.attach.maskColor,
    maskWidget: maskWidget ?? config.attach.maskWidget,
    maskIgnoreArea: maskIgnoreArea,
    onMask: onMask,
    debounce: debounce ?? config.attach.debounce,
    highlightBuilder: highlightBuilder,
    onDismiss: onDismiss,
    displayTime: displayTime,
    tag: tag,
    backDismiss: backDismiss ?? config.attach.backDismiss,
    keepSingle: keepSingle ?? false,
    permanent: permanent ?? false,
    useSystem: useSystem ?? false,
    bindPage: (bindPage ?? config.attach.bindPage) && bindWidget == null,
    bindWidget: bindWidget,
  );
}