DescribedFeatureOverlay constructor
const
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()?,
Implementation
const DescribedFeatureOverlay({
Key? key,
required this.featureId,
required this.tapTarget,
this.backgroundColor,
this.targetColor = Colors.white,
this.textColor = Colors.white,
this.title,
this.description,
required this.child,
this.onOpen,
this.onComplete,
this.onDismiss,
this.contentLocation = ContentLocation.trivial,
this.enablePulsingAnimation = true,
this.allowShowingDuplicate = false,
this.overflowMode = OverflowMode.ignore,
this.backgroundOpacity = kDefaultBackgroundOpacity,
this.openDuration = const Duration(milliseconds: 250),
this.pulseDuration = const Duration(milliseconds: 1000),
this.completeDuration = const Duration(milliseconds: 250),
this.dismissDuration = const Duration(milliseconds: 250),
this.barrierDismissible = true,
this.backgroundDismissible = false,
this.onBackgroundTap,
}) : assert(
barrierDismissible == true || onDismiss == null,
'Cannot provide both a barrierDismissible and onDismiss function\n'
'The onDismiss function will never get executed when barrierDismissible is set to false.',
),
super(key: key);