features_tour library
Classes
- ChildConfig
-
Configuration for the
childwidget. - DoneConfig
- Configuration for the "Done" button in the Features Tour.
- FeaturesTour
- The main widget for displaying a guided tour for a specific widget.
- FeaturesTourController
- Creates a FeaturesTourController for the tour with a unique pageName. The pageName is used to persist the state of the current page.
- FeaturesTourPadding
- A widget that adds padding around its child when the current tour index matches any of the specified indexes. This is useful for creating space around features during a guided tour. The padding is animated for a smooth transition.
- IntroduceConfig
-
Configuration for the
introducewidget in the Features Tour. - NextConfig
- Configuration for the "Next" button in the Features Tour.
- PreDialogConfig
- Configuration for the pre-dialog shown before starting a features tour.
- RoundedRectIntroduceConfig
- An IntroduceConfig with rounded rectangle decoration and better visible barrier color.
- SkipConfig
- Configuration for the "Skip" button in the Features Tour.
- TourAfterIntroduceCalled
-
Indicates that the
introducemethod has been called, and the introduction has finished. - TourBeforeIntroduceCalled
-
Indicates that the
introducemethod has been called, but the introduction has not yet started. - TourCompleted
- Indicates that the feature tour has been completed.
- TourDismissedAllByUser
- Indicates that the user has dismissed all feature tours.
- TourEmpty
- Indicates that there are no feature tour states to be shown.
- TourInProgress
- Indicates that the feature tour is currently in progress.
- TourIntroduceResultEmitted
- Indicates that an introduction has been completed, and a result has been emitted.
- TourIntroducing
- Indicates that a specific feature is currently being introduced.
- TourNotMounted
- Indicates that the feature tour is not currently mounted in the widget tree.
- TourPreDialogApplyToAllChanged
- Indicates that the "Apply to all pages" checkbox state has changed.
- TourPreDialogButtonPressed
- Indicates that a button in the pre-dialog has been pressed.
- TourPreDialogHidden
- Indicates that the pre-dialog for the feature tour is not shown.
- TourPreDialogHiddenByAppliedToAll
- Indicates that the pre-dialog for the feature tour is not shown because the user has applied the choice to all pages.
- TourPreDialogShownCustom
- Indicates that a custom pre-dialog for the feature tour is currently being shown.
- TourPreDialogShownDefault
- Indicates that the pre-dialog for the feature tour is currently being shown.
- TourSkippedIntroduction
- Indicates that the introduction for a specific feature should not be shown.
- TourState
- The base class for all states of the feature tour.
Enums
- IntroduceResult
-
The result of the
introducemethod. - PreDialogButtonType
- Represents the different button types available in the pre-dialog.
- QuadrantAlignment
- Specifies the quadrant alignment of a rectangle relative to a widget.
Typedefs
- BarrierColorBuilder = Color Function(BuildContext context)
- A builder function to determine the color of the modal barrier that darkens everything behind the tour.
-
CustomPreDialog
= FutureOr<
PreDialogButtonType> Function(BuildContext context, void onApplyToAllPagesCheckboxChanged(bool value)) - A function type that defines a custom pre-dialog builder.
- IntroduceBuilder = Widget Function(BuildContext context, Rect childRect, Widget introduce)
-
A builder function to wrap the
introducewidget.