OnBoardingSlider class

Inheritance

Constructors

OnBoardingSlider({required int totalPage, required Color headerBackgroundColor, required List<Widget> background, required double speed, required List<Widget> pageBodies, Function? onFinish, Function? trailingFunction, Widget? trailing, Widget? skipTextButton, Color? pageBackgroundColor, Gradient? pageBackgroundGradient, FinishButtonStyle? finishButtonStyle, String? finishButtonText, Color? controllerColor, bool addController = true, bool centerBackground = false, bool addButton = true, double imageVerticalOffset = 0, double imageHorizontalOffset = 0, Widget? leading, Widget? middle, bool hasFloatingButton = true, bool hasSkip = true, TextStyle finishButtonTextStyle = const TextStyle(fontSize: 20, color: Colors.white), Icon skipIcon = const Icon(Icons.arrow_forward, color: Colors.white), bool indicatorAbove = false, double indicatorPosition = 90, Function? skipFunctionOverride})

Properties

addButton → bool
Toggle bottom button.
final
addController → bool
Toggle bottom page controller visibilty.
final
background → List<Widget>
List of Widgets to be shown in the backgrounds of the pages. For example a picture or some illustration.
final
centerBackground → bool
Center background. Do not pass imageHorizontalOffset when you turn this flag to true otherwise that will get ignored
final
controllerColor → Color?
Color of the bottom page indicators.
final
finishButtonStyle → FinishButtonStyle?
Style of the bottom button on the last page.
final
finishButtonText → String?
Text inside last pages bottom button.
final
finishButtonTextStyle → TextStyle
Text style for text inside last pages bottom button.
final
hasFloatingButton → bool
Whether has the floating action button to skip and the finish button
final
hashCode → int
The hash code for this object.
no setterinherited
hasSkip → bool
Whether has the skip button in the bottom;
final
headerBackgroundColor → Color
NavigationBars color.
final
imageHorizontalOffset → double
Defines the horizontal offset of the background. Do not set centerBackground to true when you use this property otherwise this will get ignored
final
imageVerticalOffset → double
Defines the vertical offset of the background.
final
indicatorAbove → bool
is the indicator located on top of the screen
final
indicatorPosition → double
distance of indicator from bottom
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
leading → Widget?
leading widget in the navigationBar.
final
middle → Widget?
middle widget in the navigationBar.
final
onFinish → Function?
Callback to be executed when clicked on the finishButton.
final
pageBackgroundColor → Color?
Background Color of whole screen apart from the NavigationBar.
final
pageBackgroundGradient → Gradient?
Background Gradient of whole screen apart from the NavigationBar.
final
pageBodies → List<Widget>
The main content ont the screen displayed above the background.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skipFunctionOverride → Function?
override the function for kip button in the navigator.
final
skipIcon → Icon
icon on the skip button
final
skipTextButton → Widget?
NavigationBar trailing widget when not on last screen.
final
speed → double
The speed of the animation for the background.
final
totalPage → int
Number of total pages.
final
trailing → Widget?
NavigationBar trailing widget when on last screen.
final
trailingFunction → Function?
Callback to be executed when clicked on the last pages bottom button.
final

Methods

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