CoachMarkPresentation class

DiscoveryPresentation wrapper registered on a DiscoveryTip.

The target widget must be wrapped in a DiscoveryAnchor with a matching anchorKey. The anchor self-registers with DiscoveryAnchorRegistry, so there's no need to plumb GlobalKeys through DiscoveryContext.

Inheritance

Constructors

CoachMarkPresentation({required String anchorKey, required String message, required Color bubbleColor, Color bubbleBorderColor = const Color(0x33FFFFFF), Color? arrowColor, Color titleColor = Colors.white, Color messageColor = Colors.white, Color dismissButtonColor = const Color(0x2EFFFFFF), Color dismissButtonTextColor = Colors.white, Color closeIconColor = Colors.white, Color scrimColor = const Color(0x8C000000), Color bubbleShadowColor = const Color(0x38000000), String? title, String? dismissLabel, CoachMarkPlacement placement = CoachMarkPlacement.auto, CoachMarkStyle style = CoachMarkStyle.classic})
const

Properties

anchorKey → String
String id matched against mounted DiscoveryAnchors.
final
arrowColor → Color?
final
bubbleBorderColor → Color
final
bubbleColor → Color
See DiscoveryCoachMark.bubbleColor.
final
bubbleShadowColor → Color
final
closeIconColor → Color
final
dismissButtonColor → Color
final
dismissButtonTextColor → Color
final
dismissLabel → String?
final
hashCode → int
The hash code for this object.
no setterinherited
message → String
final
messageColor → Color
final
placement → CoachMarkPlacement
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrimColor → Color
final
style → CoachMarkStyle
final
title → String?
final
titleColor → Color
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
present(BuildContext context, DiscoveryTip<Object> tip, DiscoveryContext ctx) → Future<bool>
Return true if the presentation actually rendered. A false return (e.g. a coach mark whose anchor wasn't mounted in time) means the tip should not be marked as seen and the emit loop may continue.
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited