You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/progressbar/label.md
+4-2Lines changed: 4 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,9 @@ position: 5
10
10
11
11
# Label for the ProgressBar
12
12
13
-
The label for the ProgressBar is a text representation of the completion of the task. By default the value of completion is shown as percent `%`. This article explains how to customize the label for the `<TelerikProgressBar>`.
13
+
The label for the ProgressBar is a text representation of the completion of the task. By default, the value shows as percent `%` since the default `Max` value is `100`. If you are using a different `Max` value, then override the default label, otherwise the percent value will appear inaccurate.
14
+
15
+
This article explains how to customize the ProgressBar label position and content.
14
16
15
17
To access the customization settings use the `<ProgressBarLabel>`. It provides a `Context` which exposes a `Value` parameter which is representation of the current value of the component.
16
18
@@ -60,6 +62,6 @@ The `Template` allows you to control the entire rendering of the label for the P
Copy file name to clipboardExpand all lines: components/progressbar/overview.md
+21-94Lines changed: 21 additions & 94 deletions
Original file line number
Diff line number
Diff line change
@@ -12,14 +12,12 @@ position: 0
12
12
13
13
The <ahref = "https://www.telerik.com/blazor-ui/progressbar"target = "_blank">Blazor ProgressBar component</a> tracks the execution of operations and displays what portion of it is completed. For very long tasks, you can also make it [indeterminate]({%slug progressbar-indeterminate-state%}).
14
14
15
+
## Creating Blazor ProgressBar
15
16
16
-
## Basic ProgressBar
17
+
1. Use the `<TelerikProgressBar>` tag.
18
+
1. Set its `Value` parameter to a `double` to denote how much is completed.
17
19
18
-
To use the Telerik ProgressBar in your Blazor application:
19
-
* add the `<TelerikProgressBar>` tag.
20
-
* set its `Value` parameter to denote how much is completed.
The label is a text representation of the current progress. It is rendered inside the ProgressBar and by default shows the component value in percent. The [ProgressBar allows customization of the label position and content]({%slug progressbar-label%}). Use the label template to override the default percent label if the ProgressBar `Max` is not `100`.
52
36
53
-
*`Class` - the CSS class that will be rendered on the main wrapping element. You can use it to cascade styles more easily.
54
-
*`Max` - `double`, defaults to `100` - the maximum value of the ProgressBar. It must be greater than `0`.
55
-
*`Value` - `double` - the value of the ProgressBar. This value indicates the progress of the tracked process. It is a fraction of the `Max`.
56
-
*`Orientation` - you can control the orientation of the ProgressBar, through the `ProgressBarOrientation` enum, with members:
57
-
*`Horizontal` - this is the default value
58
-
*`Vertical`
59
-
*`Indeterminate` - `bool`, defaults to `false` - see the [Indeterminate]({%slug progressbar-indeterminate-state%}) article for more information.
60
-
*`Label` - see the [Label]({%slug progressbar-label%}) article for more information. Shows the `Value` with a `%` sign by default
37
+
## Indeterminate State
61
38
62
-
## Examples
39
+
In some scenarios the estimated time of completion is unknown or the progress cannot be strictly measured. The ProgressBar supports continuous animation that can cover these cases. [Read more about the ProgressBar Indeterminate State...]({%slug progressbar-indeterminate-state%})
63
40
64
-
###Responsive ProgressBar
41
+
## Responsive ProgressBar
65
42
66
-
>caption The ProgressBar will resize with the parent element dimensions when you set its width to 100%
43
+
The ProgressBar will resize with the parent element dimensions when you set its width to 100%:
67
44
68
45
````CSHTML
69
46
<div style="width: 50%; border: 1px solid red;">
@@ -78,72 +55,22 @@ The ProgressBar provides the following features:
78
55
</div>
79
56
````
80
57
81
-
### Use a Timer to simulate the completion of a task
82
-
83
-

| Attribute | Type and Default Value | Description |
65
+
|----------|----------|----------|
66
+
| `Class` | `string` | The CSS class that will be rendered on the main wrapping element. You can use it to cascade styles more easily.
67
+
| `Max` | `double` <br/> 100 | The maximum value of the ProgressBar. It must be greater than `0`.
68
+
| `Value` | `double` | The value of the ProgressBar. This value indicates the progress of the tracked process. It is a fraction of the `Max`.
69
+
| `Orientation` | `ProgressBarOrientation` enum <br/> (`ProgressBarOrientation.Horizontal`) | The orientation of the ProgressBar. Takes a member of the `ProgressBarOrientation` enum - `Horizontal` or `Vertical`.
136
70
137
-
InvokeAsync(StateHasChanged);
138
-
}
71
+
## Next Steps
139
72
140
-
public void StopProgress()
141
-
{
142
-
Timer?.Stop();
143
-
InvokeAsync(StateHasChanged);
144
-
}
145
-
}
146
-
````
73
+
*[Customize the ProgressBar Label]({%slug progressbar-label%})
0 commit comments