Progress

A linear or circular progress indicator showing a value within a min/max range.

ProgressComponent · type key standard.progress · Indicators

new ProgressComponent("progress")

Properties

Property	Type	Default	Binding	Description
`Value` SetValue · BindValue	`decimal?`	`null`	one-way	The current value; assigning it directly skips the Min/Max validation that SetValue applies.
`Min` SetMin · BindMin	`decimal?`	`0`	one-way	The minimum value of the progress range.
`Max` SetMax · BindMax	`decimal?`	`100`	one-way	The maximum value of the progress range.
`Variant` SetVariant · BindVariant	`UIProgressVariant?`	`UIProgressVariant.Linear`	one-way	The visual variant of the progress indicator.
`Color` SetColor · BindColor	`UIThemeColor?`	`Default`	one-way	The progress bar's colour; unset resolves to `color: inherit`, so it follows whatever it's drawn in.
`Label` SetLabel · BindLabel	`string`	`null`	one-way	The label text shown alongside the indicator. translatable
`ShowValue` SetShowValue · BindShowValue	`bool?`	`false`	one-way	Whether the numeric value is displayed alongside the indicator.
`ValueUnit` SetValueUnit · BindValueUnit	`string`	`null`	one-way	The unit shown after the value, written exactly as it should read — "%" sits against the number, " MB" stands off it. translatable

Methods

SetRange(decimal min, decimal max): Sets the minimum and maximum values of the progress range, validating them against the current value.

Common properties (16) — layout, visibility, theme, and the rest every component shares

Property	Type	Default	Binding	Description
`Visibility` SetVisibility · BindVisibility	`UIResponsive<UIVisibility>?`	`Visible`	one-way	What the component does with the room it was given, optionally overridden per breakpoint (e.g. collapsed from a given width up).
`Enabled` SetEnabled · BindEnabled	`bool?`	`true`	one-way	Whether the component responds to input; false dims it and marks it, and its subtree, inert.
`Theme` SetTheme · BindTheme	`UIThemeMode?`	`null`	one-way	The theme mode forced on this component's subtree, or `null` to inherit the ambient theme.
`HorizontalAlignment` SetHorizontalAlignment · BindHorizontalAlignment	`UIAlignment?`	`UIAlignment.Stretch`	one-way	Where the component sits within its grid cell along the horizontal axis.
`VerticalAlignment` SetVerticalAlignment · BindVerticalAlignment	`UIAlignment?`	`UIAlignment.Stretch`	one-way	Where the component sits within its grid cell along the vertical axis.
`Width` SetWidth · BindWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component width, optionally overridden per breakpoint.
`MinWidth` SetMinWidth · BindMinWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component minimum width, optionally overridden per breakpoint.
`MaxWidth` SetMaxWidth · BindMaxWidth	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component maximum width, optionally overridden per breakpoint.
`Height` SetHeight · BindHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component height, optionally overridden per breakpoint.
`MinHeight` SetMinHeight · BindMinHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component minimum height, optionally overridden per breakpoint.
`MaxHeight` SetMaxHeight · BindMaxHeight	`UIResponsive<UILayoutLength>?`	`null`	one-way	The component maximum height, optionally overridden per breakpoint.
`ZIndex` SetZIndex · BindZIndex	`int?`	`0`	one-way	The stacking order within the visual tree.
`Margin` SetMargin · BindMargin	`UIResponsive<UIThickness>?`	`null`	one-way	The outer spacing around the component, optionally overridden per breakpoint.
`Placement` SetPlacement · BindPlacement	`UIResponsive<UIGridPlacement>?`	`null`	one-way	The grid placement, optionally overridden per breakpoint.
`Loading` SetLoading · BindLoading	`bool?`	`false`	one-way	Whether the component is in loading state — a live state a controller turns on and off.
`ShowContextMenu` SetShowContextMenu · BindShowContextMenu	`bool?`	`true`	one-way	Whether a right-click opens the `IVisualComponent.ContextMenu`; on a host with rows, whether it opens any row's. Off, the menu stays in the tree and nothing opens it.