spotlight_ant 0.9.1

Spotlight the widget by wrapping it and with highly flexible configuration.

SpotlightAnt helps focus on specific widget with highly flexible configuration.

This package is separated from my project POS-System.

Play it yourself by visiting the online demo page!

See more details in example.

Installation

flutter pub add spotlight_ant

Usage

There are two main widget: SpotlightShow and SpotlightAnt.

Each individual SpotlightAnt should with the SpotlightShow widget as a common ancestor of all of those. Call methods on SpotlightShowState to show, skip, finish, go next or previous SpotlightAnt that is a descendant of this SpotlightShow.

To obtain the SpotlightShowState, you may use SpotlightShow.of with a context whose ancestor is the SpotlightShow, or pass a GlobalKey to the SpotlightShow constructor and call GlobalKey.currentState.

Widget build(BuildContext context) {
  // Wrap all the SpotlightAnt by SpotlightShow.
  return SpotlightShow(child: Column(children: [
    SpotlightAnt(
      child: MyCircularButton(),
    ),
    SpotlightAnt(
      // Using rectangle spotlight to emphasize it.
      spotlightBuilder: const SpotlightRectBuilder(),
      content: Text('this is my content'),
      child: MyRectButton(),
    ),
  ]);
}

It can also be run by program:

TabBarView(
  controller: _controller,
  children: [
    Container(),
    SpotlightAnt(
      child: Text('child'),
    ),
  ],
);
// ...
final desiredIndex = 1;
_controller.addListener(() {
  if (!_controller.indexIsChanging) {
    if (desiredIndex == _controller.index) {
      // Get the SpotlightShow from descent context.
      SpotlightShow.of(context).start();
    }
  }
});

Configuration

The configuration of SpotlightAnt:

Name	Default	Desc.
enable	true	Whether show this ant or not
spotlightBuilder	SpotlightCircularBuilder	Allow any builder that extends from SpotlightBuilder.
spotlightPadding	EdgeInsets.all(8)	-
spotlightSilent	false	Disable capturing spotlight's tap event which will start to show next spotlight.
spotlightUsingInkwell	true	Use GestureDetector instead of Inkwell.
spotlightSplashColor	null	Inkwell property.
backdropSilent	false	Disable capturing backdrop's tap event which will start to show next spotlight.
backdropUsingInkwell	true	-
backdropSplashColor	null	-
actions	[SpotlightAntAction.skip]	Actions showing in bottom, customize it by actionBuilder.
actionBuilder	null	-
nextAction	null	Change SpotlightAntAction.next default widget
prevAction	null	-
skipAction	null	-
zoomInDuration	Duration(milliseconds: 600)	-
zoomOutDuration	Duration(milliseconds: 600)	-
bumpDuration	Duration(milliseconds: 500)	Argument for AnimationController.repeat
bumpRatio	0.1	How big outer area you want in bump animation.
content	null	Content beside spotlight.
contentAlignment	null	Auto-detect it or specify it.
contentFadeInDuration	Duration(milliseconds: 300)	-
onShown	null	Callback before zoom in.
onShow	null	Callback after zoom in.
onDismiss	null	Callback before zoom out.
onDismissed	null	Callback after zoom out.
child	required	The spotlight target.

The configuration of SpotlightShow:

Name	Default	Desc.
showAfterInit	true	If you want to fire it by program, set it to false
showWaitFuture	null	Pass the Future and it will wait until it done and start the show.
routeObserver	null	Give ability to pause the show when route been pushed above current route
onSkip	null	Callback after tapping SpotlightAntAction.skip.
onFinish	null	Callback after finish the show.

Go to API doc for details.

Customize

It can be easy to customize your painter:

class MyCustomSpotlightBuilder extends SpotlightBuilder {
  @override
  SpotlightPainter build(Rect target, double value, bool isBumping) {
    // ...
  }

  @override
  double inkwellRadius(Rect target) => 0;
}

class _Painter extends SpotlightPainter {
  @override
  /// The [size] should be the window's size
  void paint(Canvas canvas, Size size) {
    // ...
  }
}

Actions is also easy too:

SpotlightAnt(
  skipAction: TextButton.icon(
    onPressed: () => SpotlightShow.of(context).skip(),
    label: const Text('MY Skip'),
    icon: const Icon(Icons.arrow_forward_ios_sharp),
  ),
  // ...
);