StdDlgDeterminateProgressItem

Displays a determinate progress indicator for tasks with a known duration

import { StdDlgDeterminateProgressItem } from "@roku-sdk/components";
StdDlgDeterminateProgressItem(props: IStdDlgDeterminateProgressItemProps): JSX.Element

Description

Displays a determinate progress indicator for tasks with a known duration.

Parameters

NameTypeDescription
propsIStdDlgDeterminateProgressItemProps

Example

<stdDlgDeterminateProgressItem percent={65} text="Downloading update…" />

Types

IStdDlgDeterminateProgressItemProps

Properties for the StdDlgDeterminateProgressItem component.

Displays a percentage progress indicator for tasks with a known duration.

NameTypeDescription
percent?numberCurrent completion percentage (0–100). See below.
text?stringText displayed next to the progress graphic. Wraps if too wide.

Extends IStdDlgItemBaseProps.

IStdDlgDeterminateProgressItemProps.percent

Current completion percentage (0–100). Clamped to the 0–100 range.

Note: The Roku documentation defines this as a string, but the SDK uses number
for a more ergonomic API. The value is converted automatically.


What’s Next

Did this page help you?