StdDlgTextItem

Displays a block of text in a StdDlgContentArea

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

Description

Displays a block of text in a StdDlgContentArea.

Parameters

NameTypeDescription
propsIStdDlgTextItemProps

Example

<stdDlgTextItem text="Your account has been updated." />
<stdDlgTextItem text="Contact support if you have questions." namedTextStyle="secondary" />

Types

IStdDlgTextItemProps

Properties for the StdDlgTextItem component.

Displays a block of text in the content area. Use multiple StdDlgTextItem nodes to separate lines of text rather than newline characters.

NameTypeDescription
audioGuideText?stringString spoken by the screen reader instead of the text field value.
namedTextStyle?INamedTextStylesSee below.
textstringText to display. Wraps if too wide for the content area.

Extends IStdDlgItemBaseProps.

IStdDlgTextItemProps.namedTextStyle

Named text style controlling font and color.

  • "normal": DialogTextColor, SmallSystemFont
  • "secondary": DialogSecondaryTextColor, SmallestSystemFont
  • "bold": DialogTextColor, SmallBoldSystemFont
  • "custom_secondary": custom secondary style
  • "centered": centered text
  • "errorcode": error code style

INamedTextStyles

Named text style for StdDlgTextItem.

type INamedTextStyles = "normal" | "secondary" | "bold" | "custom_secondary" | "centered" | "errorcode";

What’s Next

Did this page help you?