FluentBarProgressTheme class

The look of the progress indicator.

It can be set on three levels - the bar, its type and the global config - and the levels merge field by field: the bar overrides only what it set itself, the rest comes from the type, then from the config, then from the defaults. So "not set" and "set to the default value" must be told apart: getters always return a ready value, while what was set explicitly is kept separately and used for merging (see mergedOver).

Constructors

FluentBarProgressTheme({FluentBarProgressStyle? style, FluentBarProgressPosition? position, BoxDecoration? trackDecoration, Color? progressColor, double? thickness, double? size, bool? showText, bool? announceUpdates, FluentBarProgressTextAlign? textAlign, FluentBarProgressTextEffect? textEffect, Duration? textEffectDuration, Duration? animationDuration, Color? successIconColor, Widget? successIcon, Duration? successIconDuration, TextStyle? textStyle, String labelBuilder(FluentBarProgressState state)?, Widget progressBuilder(BuildContext context, ValueListenable<FluentBarProgressState?> notifier)?})
Creates a look for the progress indicator; everything left out comes from the lower levels.
const

Properties

animationDuration → Duration
How long the indicator takes to reach a new value on a jump across the whole scale (0 -> 100%).
no setter
announceUpdates → bool
Whether a screen reader announces every change of the progress (42%, 43%...). Off by default: the bar is announced when it appears and when its title or message changes, and the progress can still be read by moving to it.
no setter
hashCode → int
The hash code for this object.
no setteroverride
labelBuilder → String Function(FluentBarProgressState state)?
Builds the progress text instead of the default "42%" or "3 / 8". Not used in place of the icon (FluentBarProgressPosition.replaceIcon), which always shows the percent.
no setter
position → FluentBarProgressPosition
Where the indicator sits inside the bar.
no setter
progressBuilder → Widget Function(BuildContext context, ValueListenable<FluentBarProgressState?> notifier)?
A custom indicator widget instead of the standard one.
no setter
progressColor → Color?
The color of the indicator; by default the icon color of the bar.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showText → bool
Whether the value is shown as text next to the indicator.
no setter
size → double?
The diameter of a circular indicator.
no setter
style → FluentBarProgressStyle
A line or a ring.
no setter
successIcon → Widget?
A custom icon shown when the progress completes.
no setter
successIconColor → Color?
The color of the default success icon.
no setter
successIconDuration → Duration?
How long the success icon stays after the progress completes. Then it is removed: the indicator collapses, or the regular icon returns if the indicator replaced it. null (default) keeps the success icon until the bar closes.
no setter
textAlign → FluentBarProgressTextAlign
Where the text sits relative to the indicator.
no setter
textEffect → FluentBarProgressTextEffect
How the text changes when the value updates.
no setter
textEffectDuration → Duration
The duration of the text change effect.
no setter
textStyle → TextStyle?
The style of the progress text.
no setter
thickness → double
The thickness of the line or of the ring stroke.
no setter
trackDecoration → BoxDecoration?
A decoration drawn around the track of a linear indicator.
no setter

Methods

copyWith({FluentBarProgressStyle? style, FluentBarProgressPosition? position, BoxDecoration? trackDecoration, Color? progressColor, double? thickness, double? size, bool? showText, bool? announceUpdates, FluentBarProgressTextAlign? textAlign, FluentBarProgressTextEffect? textEffect, Duration? textEffectDuration, Duration? animationDuration, Color? successIconColor, Widget? successIcon, Duration? successIconDuration, TextStyle? textStyle, String labelBuilder(FluentBarProgressState state)?, Widget progressBuilder(BuildContext context, ValueListenable<FluentBarProgressState?> notifier)?}) → FluentBarProgressTheme
A copy with the given fields replaced; null keeps a field.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override