Showcase class

Inheritance

Constructors

Showcase({required GlobalKey<State<StatefulWidget>> key, required Widget child, String? title, required String? description, ShapeBorder? shapeBorder, Color overlayColor = Colors.black45, double overlayOpacity = 0.75, TextStyle? titleTextStyle, TextStyle? descTextStyle, Color showcaseBackgroundColor = Colors.white, Color textColor = Colors.black, Widget scrollLoadingWidget = const CircularProgressIndicator(valueColor: AlwaysStoppedAnimation(Colors.white)), bool showArrow = true, VoidCallback? onTargetClick, bool? disposeOnTap, Duration animationDuration = const Duration(milliseconds: 2000), bool? disableAnimation, EdgeInsets contentPadding = const EdgeInsets.symmetric(vertical: 8, horizontal: 8), VoidCallback? onToolTipClick, EdgeInsets overlayPadding = EdgeInsets.zero, double? blurValue, BorderRadius? radius, VoidCallback? onTargetLongPress, VoidCallback? onTargetDoubleTap, BorderRadius? tipBorderRadius})
const
Showcase.withWidget({required GlobalKey<State<StatefulWidget>> key, required Widget child, required Widget? container, required double? height, required double? width, String? title, String? description, ShapeBorder? shapeBorder, Color overlayColor = Colors.black45, BorderRadius? radius, double overlayOpacity = 0.75, TextStyle? titleTextStyle, TextStyle? descTextStyle, Color showcaseBackgroundColor = Colors.white, Color textColor = Colors.black, Widget scrollLoadingWidget = const CircularProgressIndicator(valueColor: AlwaysStoppedAnimation(Colors.white)), VoidCallback? onTargetClick, bool? disposeOnTap, Duration animationDuration = const Duration(milliseconds: 2000), bool? disableAnimation, EdgeInsets contentPadding = const EdgeInsets.symmetric(vertical: 8), EdgeInsets overlayPadding = EdgeInsets.zero, double? blurValue, VoidCallback? onTargetLongPress, VoidCallback? onTargetDoubleTap, BorderRadius? tipBorderRadius})
const

Properties

animationDuration → Duration
final
blurValue → double?
Defines blur value. This will blur the background while displaying showcase.
final
child → Widget
final
container → Widget?
final
contentPadding → EdgeInsets
final
description → String?
final
descTextStyle → TextStyle?
final
disableAnimation → bool?
final
disposeOnTap → bool?
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
final
key → GlobalKey<State<StatefulWidget>>
Controls how one widget replaces another widget in the tree.
final
onTargetClick → VoidCallback?
final
onTargetDoubleTap → VoidCallback?
final
onTargetLongPress → VoidCallback?
final
onToolTipClick → VoidCallback?
final
overlayColor → Color
final
overlayOpacity → double
final
overlayPadding → EdgeInsets
final
radius → BorderRadius?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollLoadingWidget → Widget
final
shapeBorder → ShapeBorder?
final
showArrow → bool
final
showcaseBackgroundColor → Color
final
textColor → Color
final
tipBorderRadius → BorderRadius?
final
title → String?
final
titleTextStyle → TextStyle?
final
width → double?
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<Showcase>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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