show static method

void show({
  1. required BuildContext context,
  2. required GlobalKey<State<StatefulWidget>> targetKey,
  3. required String title,
  4. required String description,
  5. Widget? leadingWidget,
  6. SubZeroCoachMarkPosition position = SubZeroCoachMarkPosition.bottom,
  7. VoidCallback? onDismiss,
})

Show a single coachmark tooltip pointing to a target widget.

Implementation

static void show({
  required BuildContext context,
  required GlobalKey targetKey,
  required String title,
  required String description,
  Widget? leadingWidget,
  SubZeroCoachMarkPosition position = SubZeroCoachMarkPosition.bottom,
  VoidCallback? onDismiss,
}) {
  dismiss();
  _onDismiss = onDismiss;

  final overlay = Overlay.of(context);
  _currentOverlay = OverlayEntry(
    builder: (context) => _CoachMarkOverlay(
      targetKey: targetKey,
      title: title,
      description: description,
      leadingWidget: leadingWidget,
      position: position,
      onDismiss: () {
        dismiss();
        _onDismiss?.call();
      },
    ),
  );

  overlay.insert(_currentOverlay!);
}