TutorialOverlayUtil library

Properties

hideOverlayHook ↔ TutorialOverlayHook?

getter/setter pair

showOverlayHook ↔ TutorialOverlayHook?

getter/setter pair

Functions

createTutorialOverlay({required String tagName, required BuildContext context, Function? onTap, Color? bgColor, Widget? description, bool enableHolesAnimation = true, bool enableAnimationRepeat = true, double defaultPadding = 4, List<WidgetData> widgetsData = const [], int highlightCount = 3, int animationMilliseconds = 150, int animationRepeatDelayMilliseconds = 3000, bool isOverlayBgTransparent = false}) → void

createTutorialOverlayIfNotExists({required String tagName, required BuildContext context, bool enableHolesAnimation = true, bool enableAnimationRepeat = true, double defaultPadding = 4, List<WidgetData> widgetsData = const [], Function? onTap, Color? bgColor, Widget? description, int highlightCount = 3, int animationMilliseconds = 150, int animationRepeatDelayMilliseconds = 3000, bool isOverlayBgTransparent = false}) → void

hideOverlayEntryIfExists({bool toRunHook = true}) → void

redrawCurrentOverlay() → void

setTutorialHideOverlayHook(TutorialOverlayHook func) → void

setTutorialShowOverlayHook(TutorialOverlayHook func) → void

showOverlayEntry({required String tagName, bool redisplayOverlayIfSameTAgName = true}) → void

waitForFrameToEnd() → Future

Typedefs

TutorialOverlayHook = void Function(String)