PrimerProgressBar class

A simple chart that can be used to show multiple colored segments in a row with a legend.

This is an implementation of the progress bar defined in GitHub Primer Design System.

Inheritance

Constructors

PrimerProgressBar({Key? key, required List<Segment> segments, int? maxTotalValue, EllipsisBuilder? legendEllipsisBuilder, SegmentedBarStyle barStyle = const SegmentedBarStyle(), SegmentedBarLegendStyle legendStyle = const SegmentedBarLegendStyle(), LegendItemBuilder legendItemBuilder = _defaultLegendItemBuilder}): Create a progress bar with a legend from Segments.
const

barStyle → SegmentedBarStyle: The style applied to the progress bar.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
legendEllipsisBuilder → EllipsisBuilder?: A builder of an ellipsis LegendItem.
final
legendItemBuilder → LegendItemBuilder: A builder that creates a LegendItems from a Segment for the legend.
final
legendStyle → SegmentedBarLegendStyle: The style applied to the legend.
final
maxTotalValue → int?: An positive integer that is used as the denominator in calculating the proportion of each segment size to the bar length.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
segments → List<Segment>: A list of Segment to be displayed in the progress bar.
final

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}) → 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