OnBoardingAnimation class

Inheritance

Constructors

OnBoardingAnimation({required List<Widget> pages, PageController? controller, double indicatorOffset = 10.0, double indicatorDotWidth = 10.0, double indicatorDotHeight = 10.0, double indicatorDotSpacing = 8.0, double indicatorDotRadius = 11.0, double indicatorJumpScale = 1.4, double indicatorVerticalOffset = 0.0, Color indicatorInActiveDotColor = Colors.grey, Color indicatorActiveDotColor = Colors.black, PaintingStyle indicatorPaintStyle = PaintingStyle.fill, PaintingStyle indicatorActivePaintStyle = PaintingStyle.fill, double indicatorScale = 1.4, double indicatorActiveDotScale = 1.3, int indicatorMaxVisibleDots = 5, bool indicatorFixedCenter = false, double indicatorActiveStrokeWidth = 1.0, double indicatorExpansionFactor = 3.0, double indicatorStrokeWidth = 1.0, WormType indicatorWormType = WormType.normal, SwapType indicatorSwapType = SwapType.normal, DotDecoration? indicatorInActiveDotDecoration, DotDecoration? indicatorActiveDotDecoration, ColorBuilder? indicatorActiveColorOverride, ColorBuilder? indicatorInActiveColorOverride, IndicatorType indicatorType = IndicatorType.worm, IndicatorPosition indicatorPosition = IndicatorPosition.bottomCenter, Key? key})
const

Properties

controller → PageController?
This parameter is use to set the page controller.
final
hashCode → int
The hash code for this object.
no setterinherited
indicatorActiveColorOverride → ColorBuilder?
This parameter is use to override the existing active and inactive colors.
final
indicatorActiveDotColor → Color
This is use to set the color of the active(selected) dot color.
final
indicatorActiveDotDecoration → DotDecoration?
indicatorActiveDotDecoration is used to set the active dot decoration if indicatorType is selected to custom.
final
indicatorActiveDotScale → double
indicatorActiveDotScale is multiplied by indicatorDotWidth to resolve active dot scaling.
final
indicatorActivePaintStyle → PaintingStyle
Inactive dots paint style (fill/stroke) defaults to fill.
final
indicatorActiveStrokeWidth → double
This is ignored if indicatorActivePaintStyle is PaintStyle.fill.
final
indicatorDotHeight → double
Set the height of indicator's dot.
final
indicatorDotRadius → double
Is use to set the radius of the circle shown in the indicator.
final
indicatorDotSpacing → double
Using this parameter user can define the space between the dots of indicator.
final
indicatorDotWidth → double
Set the width of the the indicator's dot.
final
indicatorExpansionFactor → double
indicatorExpansionFactor is multiplied by indicatorDotWidth to resolve the width of the expanded dot.
final
indicatorFixedCenter → bool
If True the old center dot style will be used.
final
indicatorInActiveColorOverride → ColorBuilder?
This parameter is use to override the existing active and inactive colors.
final
indicatorInActiveDotColor → Color
This is use to set the color of the inactive(unselected) dot color.
final
indicatorInActiveDotDecoration → DotDecoration?
indicatorInActiveDotDecoration is used to set the inactive dot decoration if indicatorType is selected to custom.
final
indicatorJumpScale → double
The maximum scale the dot will hit while jumping.
final
indicatorMaxVisibleDots → int
The max number of dots to display at a time if count is <= maxVisibleDots indicatorMaxVisibleDots = count must be an odd number that's >= 5.
final
indicatorOffset → double
This parameter is used to set the offset of the indicator.
final
indicatorPaintStyle → PaintingStyle
indicatorPaintStyle is use to select between the fill and the stroke style.
final
indicatorPosition → IndicatorPosition
This is an enum which is use to select the position of an indicator.
final
indicatorScale → double
indicatorScale is multiplied by indicatorDotWidth to resolve active dot scaling.
final
indicatorStrokeWidth → double
indicatorStrokeWidth is use to set the width of the stroke if the PaintStyle is selected to the stroke.
final
indicatorSwapType → SwapType
indicatorSwapType helps to select the form of the SwapType between normal, yRotation and zRotation.
final
indicatorType → IndicatorType
This is an enum which is use to select the type of an indicator.
final
indicatorVerticalOffset → double
The vertical offset of the jumping dot.
final
indicatorWormType → WormType
indicatorWormType helps to select the form of the WormType between normal and thin.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
pages → List<Widget>
This parameter is required. need to provide list of Widget user wants to show on onBoarding.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

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