ShowcaseCoachConfig class

Configuration options for customizing the appearance and behavior of ShowcaseCoach.

This class provides fine-grained control over colors, typography, and visual effects. All properties are optional and will fall back to sensible defaults based on the current theme.

Example

ShowcaseCoachConfig(
  primaryColor: Colors.blue,
  cardStyle: ShowcaseCoachCardStyle.glass,
  reduceMotion: false,
  titleStyle: TextStyle(fontSize: 24),
)

Constructors

ShowcaseCoachConfig({String? fontFamily, TextStyle? titleStyle, TextStyle? bodyStyle, TextStyle? buttonTextStyle, Color? primaryColor, Color? buttonColor, double overlayTintOpacity = _defaultOverlayTintOpacity, ShowcaseCoachCardStyle cardStyle = ShowcaseCoachCardStyle.glass, bool reduceMotion = false, bool showProgressIndicator = true, bool? enableTransitions, Duration? transitionDuration, Curve? transitionCurve, Duration? backdropTransitionDuration, Duration? gradientTransitionDuration, Duration? highlightTransitionDuration, Duration? cardTransitionDuration}): Creates a new showcase coach configuration.
const

Properties

backdropTransitionDuration → Duration?: Duration for backdrop hole transitions.
final
bodyStyle → TextStyle?: Optional override for the body/description text style.
final
buttonColor → Color?: Optional override for the primary CTA button color.
final
buttonTextStyle → TextStyle?: Optional override for the button text style.
final
cardStyle → ShowcaseCoachCardStyle: Visual style for the tooltip card.
final
cardTransitionDuration → Duration?: Duration for tooltip card transitions.
final
enableTransitions → bool?: Whether to enable transition animations between steps.
final
fontFamily → String?: Global font family applied to all coach text.
final
gradientTransitionDuration → Duration?: Duration for gradient overlay transitions.
final
hashCode → int: The hash code for this object.
no setterinherited
highlightTransitionDuration → Duration?: Duration for highlight position transitions.
final
overlayTintOpacity → double: Opacity for the radial gradient overlay tint.
final
primaryColor → Color?: Primary accent color used for glows, gradients, and highlights.
final
reduceMotion → bool: If true, disables heavier visual effects to improve performance.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showProgressIndicator → bool: Whether to show a progress indicator (e.g., "Step 2 of 5").
final
titleStyle → TextStyle?: Optional override for the title text style.
final
transitionCurve → Curve?: Curve for transition animations.
final
transitionDuration → Duration?: Duration for all transition animations.
final

Methods

merge(TextStyle base, TextStyle? override) → TextStyle: Merges a base TextStyle with an optional override.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

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