ProgressTabBar class

Tab bar which can be used to display a process with multiple sub steps

Allows the user to better understand process and order of sub steps, as well as progress through and navigate between them easily.

Inheritance

Constructors

ProgressTabBar({Key? key, required List<ProgressTab> children, double tabWidth = 200, double? height, double spacing = 15, double outlineWidth = 2, double? endMargin, Color? color, Color? labelColor, Color selectedLabelColor = Colors.white, int? selectedTab, ScrollPhysics? scrollPhysics, bool autoCenter = true, double autoScrollOffset = 10, Duration animationDuration = const Duration(milliseconds: 600), Curve animationCurve = Curves.fastOutSlowIn, bool disabled = false})
const

Properties

animationCurve → Curve
Set a Curve for the auto center animation. Only takes effect when autoCenter is true. Defaults to Curves.fastOutSlowIn.
final
animationDuration → Duration
Sets the duration of the centering animation. Set to 0 for instant centering. Only takes effect when autoCenter is true. Defaults to 0.6 seconds
final
autoCenter → bool
Set to false to turn off automatic centering of a tab when it is clicked. Defaults to true.
final
autoScrollOffset → double
The offset for the auto-center feature. The offset is in pixels from the left side of the widget. For example, when the previous step should still be visible, set the offset to the length of a tab plus a bit of margin. Defaults to 10.0.
final
children → List<ProgressTab>
children contains multiple ProgressTabs, which are the individual tabs inside a ProgressTabBar
final
color → Color?
color sets the color of the tab-outline as well as the tab color when tab is selected. Defaults to the primary color of the current Theme.
final
disabled → bool
When set to true, the tab bar gets disabled. All tabs will get greyed out and the bar can't be scrolled anymore. ProgressTab.onPressed will not be executed when disabled is true.
final
endMargin → double?
endMargin is is the margin after the last ProgressTabButton. Can also be negative.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double
height defines the height of the ProgressTab and therefore of the tab bar as a whole.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
labelColor → Color?
labelColor defines the color of the text in a not selected tab.
final
outlineWidth → double
outlineWidth sets the size of the outline when a tab is not selected
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollPhysics → ScrollPhysics?
Using scrollPhysics, the behaviour for scrolling through the tab bar can be configured.
final
selectedLabelColor → Color
selectedLabelColor defines the color of the text in a selected tab. Only has a effect when selectedTab is provided.
final
selectedTab → int?
When selectedTab is given, the currently selected tab is displayed with a elevated style.
final
spacing → double
spacing sets the distance between ProgressTabs
final
tabWidth → double
tabWidth controls the width of a singular tab. Gets applied to all ProgressTab in ProgressTabBar
final

Methods

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