SpotlightService class

Service that manages spotlight overlays to highlight specific UI elements.

The spotlight creates a dimmed overlay with transparent holes around target widgets, drawing user attention to specific parts of the interface.

Constructors

SpotlightService()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isShowing → bool

Whether a spotlight overlay is currently being displayed.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

hide() → Future<void>

Hides the currently displayed spotlight with an animation.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

show(BuildContext context, {required List<SpotlightTarget> targets, List<Rect>? extraHoles, List<Path>? extraHolePaths, SpotlightStyle style = const SpotlightStyle()}) → Future<void>

Shows a spotlight overlay highlighting the given targets.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited