StdDlgKeyboardItem

Displays a keyboard or PIN pad in a StdDlgContentArea

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

StdDlgKeyboardItem(props: IStdDlgKeyboardItemProps): JSX.Element

Description

Displays a keyboard or PIN pad in a StdDlgContentArea.

Parameters

Name	Type	Description
`props`	IStdDlgKeyboardItemProps

Example

<stdDlgKeyboardItem keyLayoutType={StdDlgKeyboardLayoutType.Keyboard} text="" />

Types

IStdDlgKeyboardItemProps

Properties for the StdDlgKeyboardItem component.

Displays a keyboard or PIN pad in the content area for alphanumeric/symbol/digit entry.

Name	Type	Description
`keyLayoutType?`	`StdDlgKeyboardLayoutType`	Type of keyboard to display.
`onText?`	`EventHandler<string>`	Fired whenever the text in the keyboard's text edit box changes (on each keystroke). See below.
`text?`	`string`	Default string in the text edit box. Updated as the user types.

Extends IStdDlgItemBaseProps.

IStdDlgKeyboardItemProps.onText

Fired whenever the text in the keyboard's text edit box changes (on each keystroke). The handler receives the full current string entered by the user.

Use this to react to live input — for example to validate input or enable/disable action buttons based on what the user has typed so far.

StdDlgKeyboardLayoutType

Keyboard layout type for StdDlgKeyboardItem.

Member	Value	Description
`Unspecified`	`"unspecified"`	No keyboard displayed.
`Keyboard`	`"keyboard"`	Full DynamicKeyboard for alphanumeric/symbol entry.
`PinPad`	`"pinpad"`	DynamicPinPad for digit entry.