CircularStepProgressIndicator class

Circular Progress indicator made of a series of steps. It can contain a child Widget inside.

Developed and published by Sandro Maglione https://www.sandromaglione.com

Check out the official tutorial on https://www.sandromaglione.com/blog

Inheritance

Constructors

CircularStepProgressIndicator.new({required int totalSteps, Widget? child, double? height, double? width, Color customColor(int)?, double customStepSize(int, bool)?, double? selectedStepSize, double? unselectedStepSize, bool roundedCap(int, bool)?, Gradient? gradientColor, CircularDirection circularDirection = CircularDirection.clockwise, double fallbackHeight = 100.0, double fallbackWidth = 100.0, int currentStep = 0, Color? selectedColor = Colors.blue, Color? unselectedColor = Colors.grey, double padding = math.pi / 20, double stepSize = 6.0, double startingAngle = 0, double arcSize = math.pi * 2, bool removeRoundedCapExtraAngle = false, Key? key})
const

Properties

arcSize → double
Angle in radiants which represents the size of the arc used to display the indicator. It allows you to draw a semi-circle instead of a full 360° (math.pi * 2) circle.
final
child → Widget?
Widget contained inside the circular indicator
final
circularDirection → CircularDirection
Defines if steps grow from clockwise CircularDirection.clockwise or counterclockwise CircularDirection.counterclockwise
final
currentStep → int
Number of steps to underline, all the steps with index <= currentStep will have Color equal to selectedColor
final
customColor → Color Function(int)?
Assign a custom Color for each step
final
customStepSize → double Function(int, bool)?
Assign a custom size double for each step
final
fallbackHeight → double
Height of the indicator container in case no height parameter given and parent height is double.infinity
final
fallbackWidth → double
Height of the indicator container in case no width parameter given and parent height is double.infinity
final
gradientColor → Gradient?
Adds a gradient color to the circular indicator
final
hashCode → int
The hash code for this object.
no setterinherited
height → double?
Height of the indicator's box container
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
maxDefinedSize → double
Compute the maximum possible size of the indicator between stepSize and customStepSize
no setter
padding → double
Radial spacing between each step. Remember to define the value in radiant units
final
removeRoundedCapExtraAngle → bool
Removes the extra angle caused by StrokeCap.round when roundedCap is applied
final
roundedCap → bool Function(int, bool)?
Adds rounded edges at the beginning and at the end of the circular indicator given a int, index of each step, and a bool, which tells if the step is selected based on currentStep, and must return a bool that tells if the edges are rounded or not
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedColor → Color?
Color of the selected steps
final
selectedStepSize → double?
Specify a custom size for selected steps
final
startingAngle → double
Angle in radiants in which the first step of the indicator is placed. The initial value is on the top of the indicator (- math.pi / 2)
final
startingAngleTopOfIndicator → double
Make startingAngle to top-center of indicator (0°) by default
no setter
stepSize → double
The size of a single step in the indicator
final
totalSteps → int
Total number of step of the complete indicator
final
unselectedColor → Color?
Color of the unselected steps
final
unselectedStepSize → double?
Specify a custom size for unselected steps
final
width → double?
Width of the indicator's box container
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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, int wrapWidth = 65}) → 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