showOverlay method

OverlayEntry? showOverlay({ required dynamic key, required Widget builder(Rect parent), GlobalKey<State<StatefulWidget>>? parentKey, bool barrierDismissible = true, })

Implementation

OverlayEntry? showOverlay({
  required dynamic key,
  required Widget Function(Rect parent) builder,
  GlobalKey? parentKey,
  bool barrierDismissible = true,
}) {
  assert(isInitialized);

  final overlay = Overlay.of(context!);

  if (holder.argStore.containsKey(ObjectTag.of(key))) {
    return getOverlay(key);
  }

  if (key is GlobalKey && parentKey == null) {
    parentKey = key;
  }

  final box = (parentKey?.currentState?.context.findRenderObject() ??
      context!.findRenderObject()) as RenderBox;
  final location = box.localToGlobal(Offset.zero);
  final size = box.size;

  final child = builder(
      Rect.fromLTWH(location.dx, location.dy, size.width, size.height));

  final entry = OverlayEntry(
    builder: (_) => barrierDismissible
        ? Stack(
            children: [
              GestureDetector(
                onTap: () => hideOverlay(key),
              ),
              child,
            ],
          )
        : child,
  );

  setArg(key: ObjectTag.of(key), value: entry);

  overlay.insert(entry);

  return entry;
}