UniversalCircularProgressIndicator class
A Material Design circular progress indicator, which spins to indicate that the application is busy.
A widget that shows progress along a circle. There are two kinds of circular progress indicators:
- Determinate. Determinate progress indicators have a specific value at each point in time, and the value should increase monotonically from 0.0 to 1.0, at which time the indicator is complete. To create a determinate progress indicator, use a non-null value between 0.0 and 1.0.
- Indeterminate. Indeterminate progress indicators do not have a specific value at each point in time and instead indicate that progress is being made without indicating how much progress remains. To create an indeterminate progress indicator, use a null value.
The indicator arc is displayed with valueColor, an animated value. To
specify a constant color use: AlwaysStoppedAnimation<Color>(color).
{@tool dartpad}
This example showcases determinate and indeterminate CircularProgressIndicators.
The CircularProgressIndicators will use the
** See code in examples/api/lib/material/progress_indicator/circular_progress_indicator.0.dart ** {@end-tool}
{@tool dartpad} This sample shows the creation of a CircularProgressIndicator with a changing value. When toggling the switch, CircularProgressIndicator uses a determinate value. As described in: https://m3.material.io/components/progress-indicators/overview
** See code in examples/api/lib/material/progress_indicator/circular_progress_indicator.1.dart ** {@end-tool}
See also:
- LinearProgressIndicator, which displays progress along a line.
- RefreshIndicator, which automatically displays a CircularProgressIndicator when the underlying vertical scrollable is overscrolled.
- material.io/design/components/progress-indicators.html#circular-progress-indicators
アプリケーションがビジー状態であることを示すために回転するMaterial Designの円形プログレスインジケーターです。
円に沿って進行状況を表示するウィジェットです。円形プログレスインジケーターには2つの種類があります:
- 確定的。確定的プログレスインジケーターは各時点で特定の値を持ち、 値は0.0から1.0まで単調に増加し、その時点でインジケーターが完了します。 確定的プログレスインジケーターを作成するには、0.0から1.0の間の非nullvalueを使用します。
- 不確定的。不確定的プログレスインジケーターは各時点で特定の値を持たず、 代わりに残りの進行状況を示すことなく進行中であることを示します。 不確定的プログレスインジケーターを作成するには、nullvalueを使用します。
インジケーターの弧は、アニメーション値であるvalueColorで表示されます。
定数色を指定するには:AlwaysStoppedAnimation<Color>(color)を使用します。
参照:
- LinearProgressIndicator:線に沿って進行状況を表示します。
- RefreshIndicator:基盤となる垂直スクロール可能領域がオーバースクロールされたときに CircularProgressIndicatorを自動的に表示します。
- material.io/design/components/progress-indicators.html#circular-progress-indicators
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ProgressIndicator
- CircularProgressIndicator
- UniversalCircularProgressIndicator
Constructors
-
UniversalCircularProgressIndicator({Key? key, double? value, Color? backgroundColor, Color? color, Animation<
Color?> ? valueColor, double? strokeWidth, double? strokeAlign, String? semanticsLabel, String? semanticsValue, StrokeCap? strokeCap, BoxConstraints? constraints, double? trackGap, EdgeInsetsGeometry? padding}) -
A Material Design circular progress indicator, which spins to indicate that
the application is busy.
const
-
UniversalCircularProgressIndicator.adaptive({Key? key, double? value, Color? backgroundColor, Animation<
Color?> ? valueColor, double? strokeWidth = 4.0, String? semanticsLabel, String? semanticsValue, StrokeCap? strokeCap, double? strokeAlign, BoxConstraints? constraints, double? trackGap, EdgeInsetsGeometry? padding}) -
Creates an adaptive progress indicator that is a
CupertinoActivityIndicator on TargetPlatform.iOS &
TargetPlatform.macOS and a CircularProgressIndicator in material
theme/non-Apple platforms.
const
Properties
- backgroundColor → Color?
-
Color of the circular track being filled by the circular indicator.
no setterinherited
- color → Color?
-
The progress indicator's color.
finalinherited
- constraints → BoxConstraints?
-
Defines minimum and maximum sizes for a CircularProgressIndicator.
finalinherited
- controller → AnimationController?
-
An optional AnimationController that controls the animation of this
indeterminate progress indicator.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- padding → EdgeInsetsGeometry?
-
The padding around the indicator track.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticsLabel → String?
-
The SemanticsProperties.label for this progress indicator.
finalinherited
- semanticsValue → String?
-
The SemanticsProperties.value for this progress indicator.
finalinherited
- strokeAlign → double?
-
The relative position of the stroke on a CircularProgressIndicator.
finalinherited
- strokeCap → StrokeCap?
-
The progress indicator's line ending.
finalinherited
- strokeWidth → double?
-
The width of the line used to draw the circle.
finalinherited
- trackGap → double?
-
The gap between the active indicator and the background track.
finalinherited
- value → double?
-
If non-null, the value of this progress indicator.
no setteroverride
-
valueColor
→ Animation<
Color?> ? -
The progress indicator's color as an animated value.
finalinherited
- year2023 → bool?
-
When true, the CircularProgressIndicator will use the 2023 Material Design 3
appearance.
finalinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CircularProgressIndicator> -
Creates the mutable state for this widget at a given 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