@roku-sdk/components 0.0.0-stage → 2.18.0

package/src/sg-nodes/content-node.tsx

@@ -0,0 +1,153 @@
+// Copyright (c) 2026 Roku, Inc.
+// SPDX-License-Identifier: MIT
+
+import type { IContentNodeProps, IVideoContentNodeProps } from "./content-node.props";
+import { Component } from "./types";
+export {
+    ContentType,
+    Rating,
+    StreamFormat,
+    LiveBoundsPauseBehavior,
+    StreamQuality,
+    PreferredAudioCodec,
+    PlayReadyEncodingType,
+    DrmKeySystem,
+    DrmTemplateType,
+    ContentClassifier
+} from "./content-node.props";
+
+export type {
+    IDescriptiveAttributes,
+    IStreamEntry,
+    ISubtitleTrack,
+    SubtitleTrackSource,
+    SubtitleTrackName,
+    IPlaybackConfigurationAttributes,
+    IDrmParams,
+    IDrmAttributes,
+    IContentClassificationAttributes,
+    ICdnConfigEntry,
+    ICdnSwitchingAttributes,
+    ICertificateAttributes,
+    IPlaybackControlAttributes,
+    ITrackIdAttributes,
+    IListScreenAttributes,
+    IZoomRowListDataAttributes,
+    IContentNodeProps,
+    IVideoContentNodeProps,
+    IPlaybackConfiguration
+} from "./content-node.props";
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Descriptive Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Playback Configuration Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Digital Rights Management (DRM) Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Content Classification Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// CDN Switching Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// SceneGraph Certificate Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Playback Control Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Track ID Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// roListScreen Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// ZoomRowList Data Attributes
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─────────────────────────────────────────────────────────────────────────────
+// ContentNode
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * ContentNode component for specifying data used to configure nodes and components.
+ *
+ * Many SceneGraph nodes (lists, grids, panels) require a ContentNode as the specification
+ * of their `content` field. ContentNodes are structured as a parent node with child
+ * ContentNode descendants that carry the actual content data.
+ *
+ * @example
+ * ```tsx
+ * // Simple content node for a LabelList
+ * <labelList>
+ *     <contentNode role="content">
+ *         <contentNode title="Movies" description="Browse movies" />
+ *         <contentNode title="TV Shows" description="Browse TV series" />
+ *         <contentNode title="Settings" description="App settings" />
+ *     </contentNode>
+ * </labelList>
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Content node with playback metadata for Video
+ * <contentNode
+ *     title="My Video"
+ *     url="https://example.com/video.mp4"
+ *     streamFormat="mp4"
+ * />
+ * ```
+ *
+ * @see {@link https://developer.roku.com/dev/docs/contentnode}
+ * @see {@link https://developer.roku.com/dev/docs/content-metadata}
+ */
+export const ContentNode: Component<IContentNodeProps> = props => {
+    return <contentNode {...props}></contentNode>;
+};
+
+// ─────────────────────────────────────────────────────────────────────────────
+// VideoContentNode
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * VideoContentNode component for specifying video playback content.
+ *
+ * A convenience wrapper around ContentNode used specifically for configuring video
+ * content with stream URL and format. Typically used as a child of a Video node.
+ *
+ * @remarks Assigning {@link IVideoContentNodeProps.streamformat} is not supported
+ * by the RSG SDK yet; use `url` (and other forwarded fields) only.
+ *
+ * @example
+ * ```tsx
+ * <video>
+ *     <VideoContentNode
+ *         title="Sample Video"
+ *         url="https://example.com/stream.m3u8"
+ *     />
+ * </video>
+ * ```
+ *
+ * @see {@link https://developer.roku.com/dev/docs/contentnode}
+ * @see {@link https://developer.roku.com/dev/docs/video}
+ */
+export const VideoContentNode: Component<IVideoContentNodeProps> = props => {
+    return <contentNode {...props}></contentNode>;
+};
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Backward-compatible type alias
+// ─────────────────────────────────────────────────────────────────────────────

package/src/sg-nodes/core-props.ts

@@ -0,0 +1,197 @@
+// Copyright (c) 2026 Roku, Inc.
+// SPDX-License-Identifier: MIT
+
+/**
+ * `*CoreProps` — the frozen minimal property subset for the primitive elements.
+ *
+ * Each `I*CoreProps` is the small, stable core of the corresponding `I*Props`: the properties that
+ * are guaranteed to be honoured everywhere the element renders, versioned and frozen so that code
+ * written against the core keeps working. The full `I*Props` extends its core base and adds the
+ * broader property set (`IGroupProps` is a superset of `IGroupCoreProps`, and so on).
+ *
+ * ## Why this file is purely additive
+ *
+ * These interfaces are **derived from**, never carved out of, the existing `I*Props`. Nothing in
+ * `group.props.ts`, `rectangle.props.ts`, `label.props.ts`, `poster.props.ts` or `effect.props.ts`
+ * changes, and the `jsx-props` barrel is untouched. Every core type is defined here as a `Pick<>`
+ * over the existing interface, which has three consequences that matter:
+ *
+ * 1. **No breaking change.** Existing consumers, the generated `jsx.d.ts` intrinsics map, and the
+ *    `I*Props` surface are all byte-identical to before.
+ * 2. **They cannot drift.** A core member is a projection of the real prop, so its type is
+ *    whatever the source interface says. If a source prop's type changes, the core changes with
+ *    it; if a source prop is renamed or removed, this file fails to compile rather than silently
+ *    describing a prop that no longer exists.
+ * 3. **Membership is the only thing declared here.** The list of keys in each `Pick<>` *is* the
+ *    frozen contract — that is the single decision this file makes, and it is reviewable as a
+ *    list of names.
+ *
+ * ## How membership was decided
+ *
+ * Empirically, from what the in-scope reference applications actually use: `cowboy-tv`,
+ * `fantasy-tv`, and `apps/the-roku-channel`. Regenerate the evidence with:
+ *
+ * ```
+ * node scripts/scan-core-props-usage.mjs \
+ *   ../../examples/flex-grid/cowboy-tv/src \
+ *   ../../examples/flex-grid/fantasy-tv/src \
+ *   ../../../../apps/the-roku-channel/src
+ * ```
+ *
+ * A prop earns its place by being used by a real application, not by seeming stable in the
+ * abstract. Widening a core interface is additive and safe; narrowing one is a breaking change and
+ * follows the major-bump rule in `@roku-sdk/interfaces`'s `FREEZE.md`.
+ */
+
+import type { IEffectProps } from "./effect.props";
+import type { IGroupProps } from "./group.props";
+import type { ILabelProps } from "./label.props";
+import type { INodeProps } from "./node";
+import type { IPosterProps } from "./poster.props";
+import type { IRectangleProps } from "./rectangle.props";
+import type { ITweenProps } from "./tween.props";
+
+/**
+ * Frozen minimal subset of `IGroupProps`.
+ *
+ * `group` is the base of every visual node, so these are inherited by the rectangle, label, and
+ * poster core surfaces rather than being redeclared on each.
+ *
+ * `INodeProps` is intersected in explicitly. A `Pick<>` selects only the named keys, so the
+ * framework props (`children`, `ref`, `id`, `focusable`, `gainFocus`) that `IGroupProps` inherits
+ * would otherwise be dropped — and every parent element in an application passes `children`. These
+ * are not SceneGraph properties; they are how the SolidJS layer itself works.
+ *
+ * Usage: `translation` (22 files), `opacity` / `visible` (5 each), `clippingRect` (2), and the
+ * `scale` / `scaleRotateCenter` pair (1 each — TRC's focus animation).
+ *
+ * `rotation` is included despite no in-scope app using it yet: it is the third member of the
+ * transform triple alongside `scale` and `scaleRotateCenter`, which are already here. Freezing two
+ * of the three would be arbitrary — they compose into one transform and `scaleRotateCenter` names
+ * the centre of the rotation operation, so it is meaningless without `rotation` being settable.
+ */
+export type IGroupCoreProps = INodeProps &
+    Pick<
+        IGroupProps,
+        "translation" | "rotation" | "scale" | "scaleRotateCenter" | "clippingRect" | "opacity" | "visible"
+    >;
+
+/**
+ * Frozen minimal subset of `IRectangleProps`.
+ *
+ * Usage: `color`, `width`, `height` in 22 files each — the three props that made the cowboy-tv
+ * landscape card the worked example for this exercise — plus `blendingEnabled` in 5.
+ *
+ * `blendingEnabled` is worth a note: it is almost always written in the valueless boolean form
+ * (`<rectangle blendingEnabled />`), which is exactly the shape a regex-based usage scan misses.
+ * It was absent from the first membership list for that reason. The scanner now uses the
+ * TypeScript parser.
+ *
+ * `effect` carries the styled-surface capability (rounded corners, borders, gradients). It is a
+ * child element rather than a scalar, and it degrades by design — where effects are unsupported it
+ * is silently ignored — so it is safe to write unconditionally and needs no capability branch in
+ * application code.
+ */
+export type IRectangleCoreProps = IGroupCoreProps &
+    Pick<IRectangleProps, "color" | "width" | "height" | "blendingEnabled" | "effect">;
+
+/**
+ * Frozen minimal subset of `ILabelProps`.
+ *
+ * Usage: `text`/`font`/`color`/`width`/`height`/`horizAlign`/`vertAlign`/`maxLines` in all three
+ * apps; `wrap` in fantasy-tv.
+ */
+export type ILabelCoreProps = IGroupCoreProps &
+    Pick<
+        ILabelProps,
+        "text" | "font" | "color" | "width" | "height" | "horizAlign" | "vertAlign" | "maxLines" | "wrap"
+    >;
+
+/**
+ * Frozen minimal subset of `IPosterProps`.
+ *
+ * `blendColor` multiplies the bitmap RGBA channels and is animatable by ColorFieldInterpolator.
+ *
+ * The loading/failed placeholder family is included because `fantasy-tv` and
+ * `apps/the-roku-channel` genuinely use it.
+ *
+ * `effect` is included for the same reason as on rectangle: it is the styled-surface capability,
+ * expressed as a child element, and it degrades silently where unsupported.
+ *
+ * Deliberately excluded: `loadSync`, `loadWidth`, `loadHeight` (load-time bitmap scaling),
+ * `onBitmapMargins` (9-patch, out of scope for v1), `audioGuideText`, and `shaderCompatible`.
+ */
+export type IPosterCoreProps = IGroupCoreProps &
+    Pick<
+        IPosterProps,
+        | "uri"
+        | "width"
+        | "height"
+        | "blendColor"
+        | "loadDisplayMode"
+        | "loadingBitmapUri"
+        | "loadingBitmapOpacity"
+        | "failedBitmapUri"
+        | "failedBitmapOpacity"
+        | "effect"
+    >;
+
+/**
+ * Frozen minimal subset of `IEffectProps` — which is the whole interface.
+ *
+ * No in-scope application uses `effect` yet, so unlike the other four this membership is not
+ * usage-derived; it is the whole interface by design decision.
+ */
+export type IEffectCoreProps = IEffectProps;
+
+/**
+ * Frozen minimal subset of `ITweenProps` — the portable tween field contract.
+ *
+ * Unlike the four visual primitives, this membership is not usage-derived. The tween node is still
+ * being brought up, and it does not appear in any in-scope application's source yet — the FlexGrid
+ * apps reach animation through `@roku-sdk/components`' `<Tween>` wrapper, which renders this element. The
+ * membership is instead the node's specified field contract: every field here is portable by
+ * construction, honoured by every renderer that implements the element. The freeze applies as soon
+ * as that contract is final; widening is an additive minor bump, narrowing is a major break.
+ *
+ * `INodeProps` is intersected in for the same reason as `IGroupCoreProps`: a `Pick<>` would drop
+ * the framework props (`children`, `ref`, `id`) that the SolidJS layer needs.
+ */
+export type ITweenCoreProps = INodeProps &
+    Pick<
+        ITweenProps,
+        | "targetNode"
+        | "field"
+        | "targetValue"
+        | "targetVector"
+        | "duration"
+        | "easeFunction"
+        | "axis"
+        | "preserveOther"
+        | "proposedStops"
+        | "control"
+        | "onAnimationStart"
+        | "onAnimationStop"
+        | "onAnimationState"
+    >;
+
+/**
+ * Every primitive's core surface, keyed by JSX tag. Exported so a consumer can refer to the set as
+ * a whole rather than restating it.
+ *
+ * This table also *is* the shipped intrinsic map: `core-jsx.d.ts` at the package root declares
+ * `interface IntrinsicElements extends CorePropsByTag {}` against
+ * `@roku-sdk/components/core/jsx-runtime`. So the keys here are the tags an application with
+ * `jsxImportSource: "@roku-sdk/components/core"` is allowed to write — adding a key exposes a new
+ * tag, and a primitive absent from the table is a `Property '<tag>' does not exist on type
+ * 'JSX.IntrinsicElements'` error rather than a silent pass. The membership is pinned both ways in
+ * `__tests__/core-props.test.ts`.
+ */
+export interface CorePropsByTag {
+    group: IGroupCoreProps;
+    rectangle: IRectangleCoreProps;
+    label: ILabelCoreProps;
+    poster: IPosterCoreProps;
+    effect: IEffectCoreProps;
+    tween: ITweenCoreProps;
+}

package/src/sg-nodes/custom-keyboard.props.ts

@@ -0,0 +1,108 @@
+// Copyright (c) 2026 Roku, Inc.
+// SPDX-License-Identifier: MIT
+
+import type { IKeyHandlerData } from "../key-handler.props";
+import type { IGroupProps } from "./group.props";
+import type { Component, EventHandler } from "./types";
+import type { IVoiceTextEditBoxProps } from "./voice-text-edit-box.props";
+
+/**
+ * Speech-recognition domain for voice-enabled keyboards.
+ *
+ * Controls the speech-recognition mode on DynamicKeyboardBase and its subclasses.
+ *
+ * @see {@link https://developer.roku.com/dev/docs/dynamic-keyboard-base}
+ */
+export enum KeyboardDomain {
+    /** Letter-by-letter dictation for email addresses. */
+    EMAIL = "email",
+    /** Letter-by-letter dictation for PINs, zip codes, and numeric input. */
+    NUMERIC = "numeric",
+    /** Letter-by-letter dictation for street addresses and mixed alphanumeric input. */
+    ALPHANUMERIC = "alphanumeric",
+    /** Full-word input for search queries and general text. */
+    GENERIC = "generic",
+    /** Letter-by-letter dictation for passwords. */
+    PASSWORD = "password",
+    /** Address-form keyboard layout (custom KDF). */
+    ADDRESS = "address"
+}
+
+interface PaletteColors {
+    keyboardColor?: string;
+    primaryTextColor?: string;
+    secondaryItemColor?: string;
+    focusColor?: string;
+    focusItemColor?: string;
+}
+
+/**
+ * Color palette for keyboard key grid rendering.
+ */
+export interface IKeyboardRSGPaletteNodeProps {
+    colors: PaletteColors;
+}
+
+/**
+ * Properties for the internal DynamicKeyGrid sub-node on {@link CustomKeyboard}.
+ *
+ * Not for standalone {@link DynamicKeyGrid} — use {@link IDynamicKeyGridProps} instead.
+ *
+ * @see {@link https://developer.roku.com/dev/docs/dynamic-key-grid}
+ */
+export interface IDynamicKeyGridNodeProps extends IGroupProps {
+    /**
+     * URI of the Key Definition File that defines the keyboard layout.
+     * Required for DynamicCustomKeyboard; set to a packaged `.keyboard.json` file.
+     */
+    keyDefinitionUri?: string;
+    /** Jump focus to a specific key grid position `[row, col]`. */
+    jumpToKey?: number[];
+    /** Active keyboard mode (must match a mode defined in the KDF). */
+    mode?: string;
+    /** Key label to disable in the current layout. */
+    disableKey?: string;
+    /** Key label to re-enable in the current layout. */
+    enableKey?: string;
+    /** When true, focus highlight is visible on the key grid. */
+    focusVisible?: boolean;
+    /** When true, horizontal navigation wraps at row edges. */
+    horizWrap?: boolean;
+    /** When true, vertical navigation wraps at column edges. */
+    vertWrap?: boolean;
+    /** Color palette node for keyboard theming. */
+    palette?: Component<IKeyboardRSGPaletteNodeProps>;
+    /** Fired when keyboard focus moves to a different key. */
+    onKeyFocused?: EventHandler<string>;
+    /** Fired when a key is selected, with key name and press state. */
+    onKeySelectedValue?: EventHandler<IKeyHandlerData>;
+}
+
+/**
+ * Properties inherited from DynamicKeyboardBase (key grid + text box behavior).
+ *
+ * @see {@link https://developer.roku.com/dev/docs/dynamic-keyboard-base}
+ */
+export interface IDynamicKeyboardBaseProps extends IDynamicKeyGridNodeProps {
+    /** When true, hides the internal VoiceTextEditBox. */
+    hideTextBox?: boolean;
+    /** Disables voice underscore control in the text edit box. */
+    disableVoiceUnderscoreControl?: boolean;
+    /** Shows underscore placeholders in the text edit box. */
+    showUnderscores?: boolean;
+    /** Centers underscore placeholders within the text edit box. */
+    centerUnderscores?: boolean;
+    /**
+     * Speech-recognition domain for voice entry.
+     * @see KeyboardDomain
+     */
+    domain?: KeyboardDomain;
+    /** Initial text pre-populated in the edit box on mount. */
+    initText?: string;
+}
+
+/**
+ * Full props for {@link CustomKeyboard}: DynamicKeyboardBase key-grid fields plus
+ * VoiceTextEditBox text-entry fields.
+ */
+export type IKeyboardPropsWithVoice = IDynamicKeyboardBaseProps & Partial<IVoiceTextEditBoxProps>;

package/src/sg-nodes/custom-keyboard.tsx

@@ -0,0 +1,48 @@
+// Copyright (c) 2026 Roku, Inc.
+// SPDX-License-Identifier: MIT
+
+import { retainAsset } from "../retain-asset";
+import CustomKeyboardXML from "../xml-components/keyboards/CustomKeyboard.xml";
+import type { IKeyboardPropsWithVoice } from "./custom-keyboard.props";
+import { Component } from "./types";
+export { KeyboardDomain } from "./custom-keyboard.props";
+export type {
+    IKeyboardRSGPaletteNodeProps,
+    IDynamicKeyGridNodeProps,
+    IDynamicKeyboardBaseProps,
+    IKeyboardPropsWithVoice
+} from "./custom-keyboard.props";
+
+/**
+ * Voice-enabled keyboard with a custom layout defined by a Key Definition File.
+ *
+ * CustomKeyboard extends the native DynamicCustomKeyboard node, combining a
+ * DynamicKeyGrid (custom KDF layout) with a VoiceTextEditBox for text and voice entry.
+ * Use this for standalone on-screen keyboards outside of StandardDialog.
+ *
+ * @see {@link https://developer.roku.com/dev/docs/dynamic-custom-keyboard}
+ * @see {@link https://developer.roku.com/dev/docs/dynamic-keyboard-base}
+ * @see {@link https://developer.roku.com/dev/docs/key-definition-file}
+ *
+ * @example
+ * ```tsx
+ * import { CustomAddressKDF } from "@roku-sdk/components/kdfs";
+ *
+ * <CustomKeyboard
+ *   keyDefinitionUri={CustomAddressKDF}
+ *   domain={KeyboardDomain.GENERIC}
+ *   text={query()}
+ *   hintText="Type here…"
+ *   maxTextLength={64}
+ *   showUnderscores={false}
+ *   onText={setQuery}
+ *   gainFocus
+ *   id="keyboard"
+ *   translation={[80, 140]}
+ * />
+ * ```
+ */
+export const CustomKeyboard: Component<IKeyboardPropsWithVoice> = props => {
+    retainAsset(CustomKeyboardXML);
+    return <customKeyboard {...props}></customKeyboard>;
+};

package/src/sg-nodes/dialog.props.ts

@@ -0,0 +1,159 @@
+// Copyright (c) 2026 Roku, Inc.
+// SPDX-License-Identifier: MIT
+
+import type { IGroupProps } from "./group.props";
+import type { EventHandler, Uri } from "./types";
+
+/**
+ * Properties for the Dialog node.
+ *
+ * The Dialog node defines a modal pop-up dialog used to present the user with information
+ * requiring their immediate attention. The dialog is configured to have up to five regions:
+ * title, message, bullet text, graphic, and buttons. All regions are optional except the title.
+ *
+ * Dialogs are modal and intercept all key events except the Home key. They are closed
+ * automatically when the user presses the Home or Back key. If `optionsDialog` is true,
+ * pressing the Options key also closes the dialog.
+ *
+ * > **Note:** Roku OS 10.0 introduced the StandardDialog node with updated graphics and
+ * > color palette support. Consider using StandardDialog for new development.
+ *
+ * @see {@link https://developer.roku.com/dev/docs/dialog}
+ */
+export interface IDialogProps extends IGroupProps {
+    /**
+     * Title of the dialog box, displayed at the top alongside the icon.
+     * @default ""
+     */
+    title?: string;
+    /**
+     * Color of the title text.
+     */
+    titleColor?: string;
+    /**
+     * Font of the title text.
+     */
+    titleFont?: string;
+    /**
+     * The string to be displayed in the message region of the dialog. Newline and carriage
+     * return characters in the string result in the message being displayed as multiple lines.
+     * @default ""
+     */
+    message?: string;
+    /**
+     * Color of the message text.
+     */
+    messageColor?: string;
+    /**
+     * Font of the message text.
+     */
+    messageFont?: string;
+    /**
+     * When true, the bullet text will be displayed with numbers rather than bullets.
+     * @default false
+     */
+    numberedBullets?: boolean;
+    /**
+     * An array of strings to be displayed as a list of bullet points.
+     * @default []
+     */
+    bulletText?: string[];
+    /**
+     * Color of the bullet point text.
+     *
+     * Corresponds to the `bulletTextColor` field in the Roku reference.
+     */
+    bulletColor?: string;
+    /**
+     * Font of the bullet point text.
+     *
+     * Corresponds to the `bulletTextFont` field in the Roku reference.
+     */
+    bulletFont?: string;
+    /**
+     * Allows a set of buttons to be created by providing an array of button labels.
+     * Each string results in a Button node added to the dialog's internal ButtonGroup.
+     * @default []
+     */
+    buttons?: string[];
+    /**
+     * Specifies a bitmap to be displayed in the dialog. The bitmap is displayed below
+     * the bullet text region and above the buttons.
+     * @default ""
+     */
+    graphicUri?: Uri;
+    /**
+     * Width of the bitmap graphic. If 0, the width from the image file is used.
+     * Must be set together with `graphicHeight` and before `graphicUri`.
+     * @default 0
+     */
+    graphicWidth?: number;
+    /**
+     * Height of the bitmap graphic. If 0, the height from the image file is used.
+     * Must be set together with `graphicWidth` and before `graphicUri`.
+     * @default 0
+     */
+    graphicHeight?: number;
+    /**
+     * Fired when a button in the dialog is selected. The handler receives the
+     * zero-based index of the selected button.
+     */
+    onButtonSelected?: EventHandler<number>;
+    /**
+     * Fired when a button in the dialog receives the key focus. The handler receives
+     * the zero-based index of the focused button.
+     */
+    onButtonFocused?: EventHandler<number>;
+    /**
+     * Causes the button with the specified index to receive focus when the dialog's
+     * ButtonGroup has the key focus.
+     * @default 0
+     */
+    focusButton?: number;
+    /**
+     * When true, the dialog is automatically dismissed when the Options key is pressed.
+     * @default false
+     */
+    optionsDialog?: boolean;
+    /**
+     * Specifies the bitmap to be displayed as the dialog background. Usually a 9-patch
+     * image to support dynamic resizing.
+     * @default ""
+     */
+    backgroundUri?: Uri;
+    /**
+     * Specifies a bitmap to be displayed as a small icon next to the dialog title.
+     * @default ""
+     */
+    iconUri?: Uri;
+    /**
+     * Specifies a bitmap to be displayed as the divider between the title region and
+     * the remainder of the dialog. Usually a 9-patch image.
+     * @default ""
+     */
+    dividerUri?: Uri;
+    /**
+     * Causes the dialog to be dismissed. The dialog is dismissed whenever this field
+     * is set, regardless of whether it is set to true or false.
+     * @default false
+     */
+    close: boolean;
+    /**
+     * Fired when the dialog has been closed, whether by setting `close`, pressing
+     * Back/Home, pressing Options (if `optionsDialog` is true), or because another
+     * dialog was displayed.
+     */
+    onWasClosed?: EventHandler<void>;
+    /**
+     * Width of the dialog. By default, this value is pulled from the system theme.
+     * @default -1.0
+     */
+    width?: number;
+    /**
+     * Maximum height of the dialog. By default, the dialog scales height based on contents
+     * but never larger than display resolution. Setting smaller than contents enables a
+     * scrollable text region.
+     * @default -1.0
+     */
+    maxHeight?: number;
+}