ProgressIndicator class
- Inheritance
-
- Object
- Widget
- StatelessWidget
- ProgressIndicator
Constructors
- ProgressIndicator({required double value, int width = 20, String? fillChar, String? trackChar, Color? color, Color? trackColor, bool showLabel = false, String? label, Style? labelStyle, ProgressStyle progressStyle = ProgressStyle.classic, ProgressLabelPosition labelPosition = ProgressLabelPosition.right, String borderLeft = '[', String borderRight = ']', bool showBorder = true, Color? borderColor, String labelFormat(double value)?, Key? key})
Properties
- borderColor → Color?
-
Border character color. Defaults to theme muted.
final
- borderLeft → String
-
Left border character. Set to empty string to remove.
final
- borderRight → String
-
Right border character. Set to empty string to remove.
final
-
children
→ List<
Widget> -
Child widgets that receive forwarded messages.
no setterinherited
- color → Color?
-
Fill color. Defaults to theme primary.
final
- debugRenderObjectPassthrough → bool
-
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
- fillChar → String?
-
Custom fill character. Overrides progressStyle.
final
- focusable → bool
-
Whether this widget can receive keyboard focus.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Unique identifier for this widget.
no setterinherited
- key → Key?
-
Key for preserving widget identity.
finalinherited
- label → String?
-
Custom label text. When null and showLabel is true, shows percentage.
final
- labelFormat → String Function(double value)?
-
Custom label format function. Receives the clamped value (0.0–1.0).
When provided, overrides label and the default percentage display.
final
- labelPosition → ProgressLabelPosition
-
Where to display the label relative to the bar.
final
- labelStyle → Style?
-
Style for the label text.
final
- progressStyle → ProgressStyle
-
Predefined fill/track character set.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showBorder → bool
-
Whether to show border characters around the bar.
final
- showLabel → bool
-
Whether to show a percentage label.
final
- theme → Theme
-
Access the current theme.
no setterinherited
- trackChar → String?
-
Custom track (unfilled) character. Overrides progressStyle.
final
- trackColor → Color?
-
Track color. Defaults to theme border.
final
- value → double
-
Progress value between 0.0 and 1.0.
final
- width → int
-
Width of the progress bar in columns (excluding borders and label).
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the UI represented by this widget.
override
-
buildCachedView<
T> (T builder(), Object? cacheKey) → T -
Returns a cached view if the cache key matches.
inherited
-
handleInit(
) → Cmd? -
Override this instead of init for widget-specific initialization.
inherited
-
handleIntercept(
Msg msg) → (Widget, Cmd?) -
Override this to handle messages before they reach children.
inherited
-
handleUpdate(
Msg msg) → (Widget, Cmd?) -
Override this to handle messages specific to this widget.
inherited
-
init(
) → Cmd? -
Called once when the widget is first mounted.
inherited
-
invalidateCachedView(
) → void -
Clears any cached view for this widget.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
Msg msg) → (Model, Cmd?) -
Handles messages by forwarding to children then calling handleUpdate.
inherited
-
view(
) → Object -
Renders the widget to a string or View.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited