StdDlgActionCardItem

Focusable action card that highlights child items with optional icons

import { StdDlgActionCardItem } from "@roku-sdk/components";

StdDlgActionCardItem(props: IStdDlgActionCardItemProps): JSX.Element

Description

Focusable action card that highlights child items with optional icons.

Parameters

Name	Type	Description
`props`	IStdDlgActionCardItemProps

Example

<stdDlgActionCardItem iconType="checkbox" iconStatus={isChecked()}>
    <stdDlgTextItem text="Enable notifications" />
</stdDlgActionCardItem>

Types

IStdDlgActionCardItemProps

Properties for the StdDlgActionCardItem component.

Highlights child items with optional icons (arrow, radio button, or checkbox). Drawn on top of a rectangular background tinted with the RSGPalette's DialogFootprintColor. Focusable — receives key events.

Name	Type	Description
`iconStatus?`	`boolean`	Whether the action card is checked or unchecked when `iconType` is `"checkbox"` or `"radiobutton"`.
`iconType?`	`IStdDlgActionIconType`	See below.
`onSelected?`	`EventHandler<boolean>`	Event fired when the action card item is selected. The handler receives the resulting `iconStatus` value (for `"checkbox"` and `"radiobutton"` icon types).

Extends IStdDlgItemBaseProps.

IStdDlgActionCardItemProps.iconType

Type of icon displayed on the action card.

"none": no icon
"more_info": right-pointing arrow
"checkbox": checkmark / empty box
"radiobutton": filled / empty circle

IStdDlgActionIconType

Icon type for StdDlgActionCardItem.

type IStdDlgActionIconType = "none" | "more_info" | "checkbox" | "radiobutton";