ProgressModal
Description
ProgressModal is a modal dialog component designed for displaying progress information in a blocking UI overlay. It is part of the Progress group and is ideal when you need to inform users about ongoing processes—whether they are percentage-based or indeterminate. The component supports dynamic messages, switching between a spinner and a progress indicator, and cancellation actions.
Usage
You can instantiate the ProgressModal using the static helper method from Tesserae.UI. This example demonstrates creating a progress modal with a title, a dynamic message, and a cancel button:
API reference
public class ProgressModalA modal that shows a progress bar while a long-running operation completes, with optional cancel button.
Methods
public ProgressModal Message(string message)Configures the component to message.
public ProgressModal Message(IComponent message)Configures the component to message.
public ProgressModal Title(string title)Gets or sets the title of the component.
public ProgressModal Title(IComponent title)Gets or sets the title of the component.
public ProgressModal Progress(float percent)Configures the component to progress.
public ProgressModal Progress(int position, int total)Configures the component to progress.
public ProgressModal ProgressIndeterminated()Configures the progress indeterminated on the component.
public ProgressModal ProgressSpin()Configures the progress spin on the component.
Samples
Basic Usage Sample
In this sample, the ProgressModal is displayed with dynamic updates and a cancel button. The modal starts with a spinner, updates to show percentage-based progress, and finally switches to an indeterminate state before hiding.