SpotlightHighlight class

Highlights a specific widget on screen with a spotlight/darkened backdrop.

Useful for feature onboarding, tutorials, and guided tours.

SpotlightHighlight(
  isVisible: showTip,
  message: 'Tap here to add a new item',
  child: FloatingActionButton(onPressed: _add, child: Icon(Icons.add)),
)
Inheritance
Available extensions

Constructors

SpotlightHighlight({Key? key, required Widget child, required bool isVisible, String? message, Color barrierColor = const Color(0xCC000000), double spotlightRadius = 80, BoxShape spotlightShape = BoxShape.circle, Color? borderColor, VoidCallback? onDismiss, EdgeInsets messagePadding = const EdgeInsets.symmetric(horizontal: 24, vertical: 12), TextStyle? messageStyle})
const

Properties

barrierColor → Color
Dark overlay color.
final
borderColor → Color?
Optional glowing border around the spotlight.
final
centered → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in a Center.
no setter
child → Widget
The widget to highlight.
final
hashCode → int
The hash code for this object.
no setterinherited
isVisible → bool
Whether the spotlight is active.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
message → String?
Optional caption shown below or above the spotlight.
final
messagePadding → EdgeInsets
final
messageStyle → TextStyle?
final
onDismiss → VoidCallback?
Called when the user taps outside the spotlight.
final
repaint → Widget

Available on Widget, provided by the WidgetX extension

Wraps in RepaintBoundary to isolate repaints.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spotlightRadius → double
Radius of the circular spotlight.
final
spotlightShape → BoxShape
Shape of the spotlight cutout.
final

Methods

animatedSwitcher({Duration duration = const Duration(milliseconds: 300), AnimatedSwitcherTransitionBuilder transitionBuilder = _defaultAnimatedSwitcherTransition, AnimatedSwitcherLayoutBuilder layoutBuilder = AnimatedSwitcher.defaultLayoutBuilder}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps in an AnimatedSwitcher with duration and default fade.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SpotlightHighlight>
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
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Expands the widget inside a Flex parent.
fadeIn({double opacity = 1, Duration duration = const Duration(milliseconds: 300), Curve curve = Curves.easeIn}) → Widget

Available on Widget, provided by the WidgetAnimateX extension

Wraps in an AnimatedOpacity.
flexible({int flex = 1, FlexFit fit = FlexFit.loose}) → Widget

Available on Widget, provided by the WidgetX extension

Applies flexible sizing.
keyed(Object key) → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in a KeyedSubtree with key.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(VoidCallback onTap, {HitTestBehavior behavior = HitTestBehavior.opaque}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps the widget in GestureDetector with onTap.
pad({double horizontal = 0, double vertical = 0}) → Widget

Available on Widget, provided by the WidgetX extension

Applies symmetric padding.
padded([double padding = AppSpacing.lg]) → Widget

Available on Widget, provided by the WidgetX extension

Applies uniform padding.
scaleOnTap({double scale = 0.95, required VoidCallback onTap, Duration duration = const Duration(milliseconds: 150)}) → Widget

Available on Widget, provided by the WidgetAnimateX extension

Wraps in an AnimatedScale.
semantics({required String label, bool button = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps in a Semantics node with label.
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, int wrapWidth = 65}) → 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
visible({bool condition = true}) → Widget

Available on Widget, provided by the WidgetX extension

Hides the widget entirely when condition is false.
withPadding(EdgeInsetsGeometry padding) → Widget

Available on Widget, provided by the WidgetX extension

Applies padding only.

Operators

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