Spotlight class
A widget that creates a spotlight overlay effect.
Displays a dark overlay over the entire screen with a transparent cutout around the target widget. Supports multiple shapes, pulse animations, and tap detection.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- Spotlight
Constructors
- Spotlight({Key? key, required Rect targetRect, double padding = 8.0, Color overlayColor = const Color.fromRGBO(0, 0, 0, 0.7), HighlightShape shape = HighlightShape.rounded, double borderRadius = 12.0, bool showPulse = false, VoidCallback? onTargetTap, Color pulseColor = Colors.white})
-
const
Properties
- borderRadius → double
-
Border radius for rounded/rectangle shapes
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onTargetTap → VoidCallback?
-
Callback when the target area is tapped
final
- overlayColor → Color
-
Color of the overlay (typically semi-transparent black)
final
- padding → double
-
Extra padding around the target for the cutout
final
- pulseColor → Color
-
Color of the pulse animation
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shape → HighlightShape
-
Shape of the spotlight cutout
final
- showPulse → bool
-
Whether to show a pulsing animation around the target
final
- targetRect → Rect
-
The rectangle defining the target widget's position and size
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< Spotlight> -
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, 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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited