showcase/showcase_navigator library

Classes

ShowcaseNavigation

Opens and closes the pages of the demo. Get it with context.showcase.

ShowcaseNavigator<P extends Enum>

Navigation of the demo, with the plain Flutter Navigator. The pages are the values of an enum P, opened with context.showcase, and every page gets its highlights.

Extensions

ShowcaseNavigationX on BuildContext

Gives access to the navigation of the demo.

Functions

isShowcaseOnTop(BuildContext context) → bool

Whether nothing covers the navigator of the demo, such as a sheet in the root navigator. True outside a ShowcaseNavigator. Not exported: the pages use it to tell whether they are on screen.

Typedefs

ShowcaseHighlightsBuilder<P extends Enum> = List<Highlight> Function(BuildContext context, P page, ShowcaseState state)

The highlights of a page, which may depend on how far the visitor has come.

ShowcasePageBuilder<P extends Enum> = Widget Function(BuildContext context, P page, Object? args)

Builds the screen for a page, with the arguments it was opened with.