Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mamatt/progress ring determinate #93

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Mamatt/progress ring determinate #93

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
43f770a
Updated API and description
MarissaMatt Jul 21, 2020
908a760
Updated images and formatting
MarissaMatt Jul 21, 2020
a36d134
Update image.
MarissaMatt Jul 21, 2020
8742992
Update ProgressRing.md
MarissaMatt Jul 21, 2020
f7452b6
Update to include example of asyncronous scenario and remove properties.
MarissaMatt Aug 11, 2020
a7e8e05
Update example and progress ring image
MarissaMatt Aug 17, 2020
35e7126
Updated API to derive from Control
MikeHillberg Oct 16, 2020
2329a77
Moved to a new doc so all the lines can be commented on
MikeHillberg Oct 22, 2020
78d5461
Added statement about the source.
MarissaMatt Oct 29, 2020
cc64719
Updates
MikeHillberg Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 38 additions & 117 deletions active/progress/ProgressRing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,4 @@
<!--See comments in Markdown for how to use this spec template->

<!-- The purpose of this spec is to describe a new feature and
its APIs that make up a new feature in WinUI. -->

<!-- There are two audiences for the spec. The first are people
that want to evaluate and give feedback on the API, as part of
the submission process. When it's complete
it will be incorporated into the public documentation at
docs.microsoft.com (http://docs.microsoft.com/uwp/toolkits/winui/).
Hopefully we'll be able to copy it mostly verbatim.
So the second audience is everyone that reads there to learn how
and why to use this API. -->

# Background
<!-- Use this section to provide background context for the new API(s)
in this spec. -->

<!-- This section and the appendix are the only sections that likely
do not get copied to docs.microsoft.com; they're just an aid to reading this spec. -->

<!-- If you're modifying an existing API, included a link here to the
existing page(s) -->

<!-- For example, this section is a place to explain why you're adding this API rather than
modifying an existing API. -->

<!-- For example, this is a place to provide a brief explanation of some dependent
area, just explanation enough to understand this new API, rather than telling
the reader "go read 100 pages of background information posted at ...". -->

>See proposal documents for:
>
> [determinate mode for ProgressRing](https://github.com/microsoft/microsoft-ui-xaml/issues/688)
Expand All @@ -41,25 +11,11 @@ Progress controls indicate to a user that an operation is occuring. This include

Important APIs: [ProgressBar](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.progressbar) and [ProgressRing](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.controls.progressring)
# Description
<!-- Use this section to provide a brief description of the feature.
For an example, see the introduction to the PasswordBox control
(http://docs.microsoft.com/windows/uwp/design/controls-and-patterns/password-box). -->
Represents a control that indicates that an operation is ongoing. The typical visual appearance is a ring-shaped "spinner" that animates a filled area as progress continues.

By default, the progress ring will display an indeterminate spinner that continuously animates until the control is no longer visible. You can change the behavior to dislpay a determinate ring that fills in based on the value you provide.

# Examples
<!-- Use this section to explain the features of the API, showing
example code with each description. The general format is:
feature explanation,
example code
feature explanation,
example code
etc.-->

<!-- Code samples should be in C# and/or C++/WinRT -->

<!-- As an example of this section, see the Examples section for the PasswordBox control
(https://docs.microsoft.com/windows/uwp/design/controls-and-patterns/password-box#examples). -->
[Please see this table of current ProgressBar and ProgressRing modes and states.](https://github.com/microsoft/microsoft-ui-xaml-specs/blob/user/kathyang/progress-styles/active/progress-styles/progress-styles-tables.md)

The following examples show how to use the IsIndeterminate property to change the mode of the ProgressRing and the Value property to change the proportionate amount indicated.

Expand All @@ -69,73 +25,16 @@ The following examples show how to use the IsIndeterminate property to change th
<ProgressRing IsActive="True" Height="100" Width="100"/>
```

![](images/ProgressRing-indeterminate.PNG)
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved
![](images/ProgressRing-indeterminate.jpg)
## Determinate ProgressRing

```xml
<ProgressRing IsActive="True" Height="100" Width="100" Value="75" IsIndeterminate="False"/>
ranjeshj marked this conversation as resolved.
Show resolved Hide resolved
```
![](images/ProgressRing-determinate.PNG)

Below are tables showing how ProgressRing is affected by the IsActive, IsIndeterminate, ShowPaused, ShowError and Value properties.

## Inactive ProgressRing
| Note | Image |
|:--|:-:|
| When IsActive is False, ProgressRing will always appear blank, regardless of other properties | ![](images/ProgressRing-determinate-not-active.PNG) |

## Indeterminate ProgressRing
IsIndeterminate is True

| ShowPaused | ShowError| Value | Image |
|:--|:-:| :-:| :-:|
| False | False | | ![](images/ProgressRing-indeterminate.PNG) |
| False | False | 75 | ![](images/ProgressRing-indeterminate.PNG) |
| False | True | | ![](images/ProgressRing-determinate-empty.PNG) |
| False | True | 75 | ![](images/ProgressRing-determinate-empty.PNG) |
| True | False | | ![](images/ProgressRing-determinate-empty.PNG) |
| True | False | 75 | ![](images/ProgressRing-determinate-empty.PNG) |
| True | True | | ![](images/ProgressRing-determinate-empty.PNG) |
| True | True | 75 | ![](images/ProgressRing-determinate-empty.PNG) |

Setting a Value on an Indeterminate ProgressRing should display as though there is no Value.

## Determinate ProgressRing
IsIndeterminate is False

| ShowPaused | ShowError| Value | Image |
|:--|:-:| :-:| :-:|
| False | False | | ![](images/ProgressRing-determinate-empty.PNG) |
| False | False | 0 | ![](images/ProgressRing-determinate-empty.PNG) |
| False | False | 75 | ![](images/ProgressRing-determinate.PNG) |
| False | True | | ![](images/ProgressRing-determinate-empty.PNG) |
| False | True | 75 | ![](images/ProgressRing-determinate-empty.PNG) |
| True | False | | ![](images/ProgressRing-determinate-empty.PNG) |
| True | False | 75 | ![](images/ProgressRing-determinate-paused.PNG) |
| True | True | | ![](images/ProgressRing-determinate-empty.PNG) |
| True | True | 75 | ![](images/ProgressRing-determinate-empty.PNG) |

### Minimum and Maximum

ProgressRing should indicate progress based on the Value, relative to the Minimum and Maximum.

| Properties | Image |
|:--|:-:|
| Minimum=10, Maximum=18, and Value=16| ![](images/ProgressRing-determinate.PNG) |

*Note that the designs for ProgressRing are not finalized. See [here](https://github.com/microsoft/microsoft-ui-xaml-specs/blob/user/chigy/ControlUpdates/active/ControlUpdates/images/Progress.png) for early designs.

# Remarks
<!-- Explanation and guidance that doesn't fit into the Examples section. -->

<!-- APIs should only throw exceptions in exceptional conditions; basically,
only when there's a bug in the caller, such as argument exception. But if for some
reason it's necessary for a caller to catch an exception from an API, call that
out with an explanation either here or in the Examples -->

With the addition of a determinate mode of ProgressRing, the ShowPaused and ShowError properties that ProgressBar already has should be aligned in ProgressRing. ProgressRing can be used in scenarios where progress is paused, or an error occured during the process. With this additional capability, the determinate ProgressRing does not represent a "hung" state where the user cannot interact with the app. Previously, guidance recommended that ProgressRing only be used when the user cannot continue to interact with the app, but this is no longer the only use case and ProgressRing can be used in scenarios where user interaction can continue while the ring is spinning.

ProgressRing will continue to inherit from Control, and will not inherit from RangeBase. Rangebase has functionality that is not used in ProgressBar and would not be used in ProgressRing. There is an ongoing investigation into adding content (Text or icons) in the center of the ProgressRing to potentially align with Xbox and other Microsoft teams.

# API Notes
<!-- Option 1: Give a one or two line description of each API (type
Expand All @@ -146,25 +45,47 @@ isn't the type's default (for example an int-typed property that doesn't default

<!-- Option 2: Put these descriptions in the below API Details section,
with a "///" comment above the member or type. -->
Below are properties being added to ProgressRing. The IsIndeterminate property of ProgressRing will default to True for back compatability.

|Name | Type | Description |
|:--|:-:|:-:|
| IsIndeterminate | boolean | Defaults to True. Gets or sets a value that indicates whether the progress ring reports generic progress with a repeating pattern (indeterminate progress) or reports progress based on the Value property (determinate progress) |
| Value | double | Gets or sets the current setting of the range control, which may be coerced. |
| ShowPaused | boolean | Defaults to False. Gets or sets a value that indicates whether the progress bar should use visual states that communicate a Paused state to the user.|
| ShowError | boolean | Defaults to False. Gets or sets a value that indicates whether the progress bar should use visual states that communicate an Error state to the user. |
| Maximum | double | Defaults to 100. Gets or sets the highest possible Value of the range element. |
| Minimum | double | Defaults to 0. Gets or sets the Minimum possible Value of the range element. |
| ValueChanged | event | Event that occurs when the range value changes. |
ProgressRing can now be used in scenarios where progress is determinate or indeterminates. With this additional capability, the determinate ProgressRing does not represent a "hung" state where the user cannot interact with the app. Previously, guidance recommended that ProgressRing only be used when the user cannot continue to interact with the app, but this is no longer the only use case and ProgressRing can be used in scenarios where user interaction can continue while the ring is spinning.
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved

Below are properties being added to ProgressRing. The IsIndeterminate property of ProgressRing will default to True for backwards compatability.

|Name | Type | Description | Default |
|:--|:-:|:-:|:-:|
| IsIndeterminate | boolean | Gets or sets a value that indicates whether the progress ring reports generic progress with a repeating pattern (indeterminate progress) or reports progress based on the Value property (determinate progress) | True |
| IsActive | boolean | Gets or sets a value that indicates whether the progress ring is being displayed to the end user. If IsActive is false, the ProgressRing is not shown, but space is reserved for it in the UI layout. To not reserve space for it, set its Visibility property to Collapsed. | True |
| Value | double | Gets or sets the current setting of the range control, which may be coerced. The value ranges from 0 to 100. | 0 |
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved
| DeterminateSource | AnimatedVisualSource | Gets or sets the Lottie animation file used for the determinate state of the ring. | N/A |
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved
| IndeterminateSource | AnimatedVisualSource | Gets or sets the Lottie animation file used for the indeterminate state of the ring. | N/A |
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved
| ValueChanged | event | Event that occurs when the range value changes. | N/A |
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved

# API Details
<!-- The exact API, in MIDL3 format (https://docs.microsoft.com/en-us/uwp/midl-3/) -->
```xaml
Unsealed runtimeclass ProgressRing : Microsoft.UI.Xaml.Controls.Control.RangeBase
{
ProgressRing();

Boolean IsActive;
Boolean IsIndeterminate;
Double Value;
MarissaMatt marked this conversation as resolved.
Show resolved Hide resolved

IAnimatedVisualSource DeterminateSource{ get; set; };
IAnimatedVisualSource IndeterminateSource{ get; set; };

ProgressRingTemplateSettings TemplateSettings{ get; };
ranjeshj marked this conversation as resolved.
Show resolved Hide resolved

static Microsoft.UI.Xaml.DependencyProperty IsActiveProperty{ get; set};
static Microsoft.UI.Xaml.DependencyProperty IsIndeterminateProperty{ get; };
static Mircorsoft.UI.Xaml.DependencyProperty DeterminateSourceProperty{ get; };
static Microsoft.UI.Xaml.IndeterminateSourceProperty{ get; };
}
```


# Appendix
<!-- Anything else that you want to write down for posterity, but
that isn't necessary to understand the purpose and usage of the API.
For example, implementation details. -->

# Open Questions
* How should the edge cases of 0%, 1%, 98%, 99% be visualized? We are currently discussing with other teams at Microsoft how to visualize this with the rounded interior corners.
## Design Behavior Details
The determinate progress ring will be an empty ring when the progress is set to a value of 0. When value is set to 1, a blue dot will appear and then continue to fill as the value increases. When the value is set to 98 or 99, the ring will not be completely filled to indicate to the user that progress is not complete.
Binary file removed active/progress/images/ProgressRing-indeterminate.PNG
View file
Open in desktop
Binary file not shown.
Binary file added active/progress/images/ProgressRing-indeterminate.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.