Tesserae

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

class

ProgressModal

public class ProgressModal

A modal that shows a progress bar while a long-running operation completes, with optional cancel button.

Constructors

Constructor
ProgressModal
public ProgressModal()

Initializes a new instance of this class.

Methods

Method
ProgressModal.Show
public ProgressModal Show()

Shows the component.

Method
ProgressModal.ShowEmbedded
public IComponent ShowEmbedded()

Shows the embedded.

Method
ProgressModal.Hide
public ProgressModal Hide()

Hides the component.

Method
ProgressModal.Message
public ProgressModal Message(string message)

Configures the component to message.

Method
ProgressModal.Message
public ProgressModal Message(IComponent message)

Configures the component to message.

Method
ProgressModal.Title
public ProgressModal Title(string title)

Gets or sets the title of the component.

Method
ProgressModal.Title
public ProgressModal Title(IComponent title)

Gets or sets the title of the component.

Method
ProgressModal.Progress
public ProgressModal Progress(float percent)

Configures the component to progress.

Method
ProgressModal.Progress
public ProgressModal Progress(int position, int total)

Configures the component to progress.

Method
ProgressModal.ProgressIndeterminated
public ProgressModal ProgressIndeterminated()

Configures the progress indeterminated on the component.

Method
ProgressModal.ProgressSpin
public ProgressModal ProgressSpin()

Configures the progress spin on the component.

Method
ProgressModal.WithCancel
public ProgressModal WithCancel(Action<Button> onCancel, Action<Button> btnCancel = null)

Returns the component configured with the given cancel.

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.

See also

Referenced by

© 2026 Tesserae. All rights reserved.