DescribedFeatureOverlay class
Constructors
-
DescribedFeatureOverlay({Key? key, required String featureId, required Widget tapTarget, Color? backgroundColor, Color targetColor = Colors.white, Color textColor = Colors.white, Widget? title, Widget? description, required Widget child, Future<bool> onOpen()?, Future<bool> onComplete()?, Future<bool> onDismiss()?, ContentLocation contentLocation = ContentLocation.trivial, bool enablePulsingAnimation = true, bool allowShowingDuplicate = false, OverflowMode overflowMode = OverflowMode.ignore, double backgroundOpacity = kDefaultBackgroundOpacity, Duration openDuration = const Duration(milliseconds: 250), Duration pulseDuration = const Duration(milliseconds: 1000), Duration completeDuration = const Duration(milliseconds: 250), Duration dismissDuration = const Duration(milliseconds: 250), bool barrierDismissible = true, bool backgroundDismissible = false, Future<bool> onBackgroundTap()?})
-
const
Properties
-
allowShowingDuplicate
→ bool
-
By default, for every feature id, i.e. for every step in the feature discovery,
there can only be a single active overlay at a time as the default value
for allowShowingDuplicate is
false.
final
-
backgroundColor
→ Color?
-
The color of the large circle, where the text sits on.
If null, defaults to ThemeData.primaryColor.
final
-
backgroundDismissible
→ bool
-
Controls whether the overlay should be dismissed on touching the background or not.
final
-
backgroundOpacity
→ double
-
The opacity of the large circle, where the text sits on.
If null, defaults to 0.96.
final
-
barrierDismissible
→ bool
-
Controls whether the overlay should be dismissed on touching outside or not.
final
-
child
→ Widget
-
final
-
completeDuration
→ Duration
-
Duration for overlay complete animation.
final
-
contentLocation
→ ContentLocation
-
final
-
description
→ Widget?
-
This is the second content widget, i.e. it is displayed below description.
final
-
dismissDuration
→ Duration
-
Duration for overlay dismiss animation.
final
-
enablePulsingAnimation
→ bool
-
final
-
featureId
→ String
-
This id should be unique among all the DescribedFeatureOverlay widgets.
Otherwise, multiple overlays would show at once, which is currently
only possible if allowShowingDuplicate is set to
true.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
key
→ Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
onBackgroundTap
→ (Future<bool> Function()?)
-
Called whenever the user taps inside the overlay area.
This function needs to return a bool, either from an
async scope
or as a Future.
final
-
onComplete
→ (Future<bool> Function()?)
-
Called when the tap target is tapped.
Whenever the Future this function returns finishes with
true, the feature discovery
will continue and the next step will try to open after a closing animation.
If it completes with false, nothing happens.
final
-
onDismiss
→ (Future<bool> Function()?)
-
Called whenever the user taps outside the overlay area.
This function needs to return a bool, either from an
async scope
or as a Future.
final
-
onOpen
→ (Future<bool> Function()?)
-
Called just before the overlay is displayed.
This function needs to return a bool, either from an
async scope
or as a Future.
final
-
openDuration
→ Duration
-
Duration for overlay open animation.
final
-
overflowMode
→ OverflowMode
-
Controls what happens with content that overflows the background's area.
final
-
pulseDuration
→ Duration
-
Duration for target pulse animation.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
tapTarget
→ Widget
-
This is usually an Icon.
The final tap target will already have a tap listener to finish each step.
final
-
targetColor
→ Color
-
Color of the target, that is the small circle behind the tap target.
final
-
textColor
→ Color
-
Color for title and text.
final
-
title
→ Widget?
-
This is the first content widget, i.e. it is displayed above description.
final
