StandardProgressDialog
Displays a progress dialog with a spinning indicator and message
import { StandardProgressDialog } from "@roku-sdk/components";StandardProgressDialog(props: IStandardProgressDialogProps): JSX.ElementDescription
Displays a progress dialog with a spinning indicator and message.
StandardProgressDialog is a pre-built dialog similar to the legacy ProgressDialog node. It displays a spinning progress indicator for tasks with an indeterminate duration.
Note: Unlike other standard dialogs, StandardProgressDialog has no buttons — it only displays a spinner with a message. Close the dialog programmatically by setting close to true or by unmounting the component.
Parameters
| Name | Type | Description |
|---|---|---|
props | IStandardProgressDialogProps |
Example
const [isLoading, setIsLoading] = createSignal(true);
// Show progress dialog while loading
{isLoading() && (
<StandardProgressDialog
title="Loading"
message="Please wait..."
/>
)}
// When loading completes, hide the dialog
setTimeout(() => setIsLoading(false), 3000);Types
IStandardProgressDialogProps
Properties for the StandardProgressDialog component.
Extends IStandardDialogProps (omitting button events since progress dialogs have no buttons) with fields for displaying a spinning progress indicator.
| Name | Type | Description |
|---|---|---|
message? | string | A string displayed next to the spinning progress indicator. Typically tells the user why they are waiting. Minimize message length. |
title? | string | The title displayed at the top of the dialog. If empty, the dialog displays without a title area and uses minimum width. |
Extends Omit<IStandardDialogProps, "onButtonSelected" | "onButtonFocused">.
Updated about 3 hours ago