FlutterOnBoarding class

Inheritance

Constructors

FlutterOnBoarding({Key? key, required List<IntroModel> pages, Axis scrollDirection = Axis.vertical, ScrollPhysics? physics = const BouncingScrollPhysics(), required VoidCallback onDone, ShapeBorder? activeIndicatorShape, ShapeBorder? inactiveIndicatorShape, Size? activeIndicatorSize, Size? inactiveIndicatorSize, PageController? pageController, String? skipButtonText, String? nextButtonText, String? doneButtonText, Widget? indicator, Widget? navigationControl, Color? indicatorActiveColor, Color? indicatorInactiveColor, Color? skipButtonColor, Color? nextButtonColor, Widget? loadingWidget, bool shouldUseDefaultStorage = true})

Properties

activeIndicatorShape → ShapeBorder?
The shape of the dot indicator. Defaults to RoundedRectangleBorder.
final
activeIndicatorSize → Size?
The size of the dot indicator. Defaults to Size.square(10.0).
final
doneButtonText → String?
Done Button Text
final
hashCode → int
The hash code for this object.
no setterinherited
inactiveIndicatorShape → ShapeBorder?
The shape of the dot indicator. Defaults to RoundedRectangleBorder.
final
inactiveIndicatorSize → Size?
The size of the dot indicator. Defaults to Size.square(10.0).
final
indicator → Widget?
The widget to show as the indicator. Defaults to DotsIndicator.
final
indicatorActiveColor → Color?
Indicator active color. Defaults to Theme.of(context).primaryColor.
final
indicatorInactiveColor → Color?
Indicator inactive color. Defaults to Colors.grey.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingWidget → Widget?
Widget that shows before inititalizing the onboarding flow. Defaults to CircularProgressIndicator.
final
The widget for controlling the state of the onboarding flow. i.e. Navigation buttons.
final
nextButtonColor → Color?
Next TextButton color. Defaults to Theme.of(context).primaryColor.
final
nextButtonText → String?
Next Button Text
final
onDone → VoidCallback
Onboarding done callback. This is called when the user taps the done button.
final
pageController → PageController?
Page controller used to control the scrolling of the onboarding flow.
final
pages → List<IntroModel>
The list of pages to display in the onboarding flow. Pages are of type IntroModel, and are rendered in order.
final
physics → ScrollPhysics?
Scroll Physics. Defaults to BouncingScrollPhysics.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollDirection → Axis
For the direction of the scroll, use Axis.horizontal for left-to-right scrolling, and Axis.vertical for top-to-bottom scrolling.
final
shouldUseDefaultStorage → bool
Whether to use the default storage to store the onboarding state. Defaults to true. This is useful if you want to use your own storage, from inside your logic. If this is set to false and you don't provide your own storage logic, the onboarding flow will not be marked as done. and will reappear on every app launch. Note: Handle the one time show logic yourself if you set this to false.
final
skipButtonColor → Color?
Skip TextButton color. Defaults to Theme.of(context).primaryColor.
final
skipButtonText → String?
Skip Button Text
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FlutterOnBoarding>
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}) → 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