StdDlgTitleArea
Title area component displayed at the top of a StandardDialog
import { StdDlgTitleArea } from "@roku-sdk/components";StdDlgTitleArea(props: IStdDlgTitleAreaProps): JSX.ElementDescription
Title area component displayed at the top of a StandardDialog.
A dialog may contain a single optional title area. Use it to display a title string with optional primary (left) and secondary (right) icons.
Parameters
| Name | Type | Description |
|---|---|---|
props | IStdDlgTitleAreaProps |
Example
<stdDlgTitleArea
primaryTitle="Settings"
primaryIcon="pkg:/images/settings-icon.png"
/>Types
IStdDlgTitleAreaProps
Properties for the StdDlgTitleArea component.
Contains the dialog's title information, always displayed at the top of the dialog. May include optional primary and secondary icons alongside the title text.
| Name | Type | Description |
|---|---|---|
primaryIcon? | Uri | URI of a bitmap displayed at the left edge of the title area, to the left of the primary title. |
primaryIconVertOffset? | number | Vertical position adjustment of the primary icon relative to the title baseline. |
primaryTitle? | string | Title text displayed in the dialog's title area. |
secondaryIcon? | Uri | URI of a bitmap displayed at the right edge of the title area. |
secondaryIconVertOffset? | number | Vertical position adjustment of the secondary icon relative to the title baseline. |
Extends IStdDlgAreaBaseProps.
Updated about 3 hours ago
What’s Next
Did this page help you?