OnboardingStep constructor

const OnboardingStep({
  1. required GlobalKey<State<StatefulWidget>> targetKey,
  2. List<GlobalKey<State<StatefulWidget>>>? extraTargetKeys,
  3. String? description,
  4. Widget? descriptionWidget,
  5. bool showNext = true,
  6. bool showSkip = true,
  7. OnboardingTooltipPosition position = OnboardingTooltipPosition.auto,
  8. Map<GlobalKey<State<StatefulWidget>>, OnboardingTooltipPosition>? keyPositions,
  9. Map<GlobalKey<State<StatefulWidget>>, double>? maxHeights,
  10. Map<GlobalKey<State<StatefulWidget>>, double>? customWidths,
  11. Map<GlobalKey<State<StatefulWidget>>, BorderRadius>? borderRadii,
  12. double? spotlightHorizontalPadding,
  13. double tooltipVerticalOffset = 0,
  14. Map<GlobalKey<State<StatefulWidget>>, bool>? targetClickables,
  15. List<GlobalKey<State<StatefulWidget>>>? arrowAnchorKeys,
  16. List<ArrowPosition>? arrowPositions,
})

Creates an onboarding step with the given configuration.

Either description or descriptionWidget must be provided.

Implementation

const OnboardingStep({
  required this.targetKey,
  this.extraTargetKeys,
  this.description,
  this.descriptionWidget,
  this.showNext = true,
  this.showSkip = true,
  this.position = OnboardingTooltipPosition.auto,
  this.keyPositions,
  this.maxHeights,
  this.customWidths,
  this.borderRadii,
  this.spotlightHorizontalPadding,
  this.tooltipVerticalOffset = 0,
  this.targetClickables,
  this.arrowAnchorKeys,
  this.arrowPositions,
}) : assert(description != null || descriptionWidget != null,
          'Either description or descriptionWidget must be provided');