@roku-sdk/components 0.0.0-stage → 2.18.0

package/src/xml-components/keyboards/CustomKeyboard.brs

@@ -0,0 +1,322 @@
+Sub Init()
+    this = m.top
+    textEditBox = this.textEditBox
+
+    textEditBox.disableVoiceUnderscoreControl = true
+    textEditBox.active = true
+    textEditBox.observeFieldScoped("text", "textChanged")
+    textEditBox.observeFieldScoped("isDictating", "isDictatingChanged")
+    textEditBox.observeField("renderTracking", "KeyChanged")
+End Sub
+
+' Re-apply Ext underscore props when dictation ends (OS may not restore them
+' while disableVoiceUnderscoreControl is true).
+Sub isDictatingChanged(event as Object)
+    m.top.isDictating = event.getData()
+    if event.getData() = false
+        showUnderscoresChanged()
+        centerUnderscoresChanged()
+    end if
+End Sub
+
+Sub KeyChanged()
+    disableKeyChanged()
+    enableKeyChanged()
+End Sub
+
+Sub modeChanged()
+    this = m.top
+    m.currMode = this.mode
+    if m.currMode <> this.keyGrid.mode
+        this.keyGrid.mode = m.currMode
+    end if
+End Sub
+
+Sub initTextChanged()
+    applyInitText()
+End Sub
+
+Sub keyDefinitionUriChanged()
+    this = m.top
+    if this.keyDefinitionUri <> invalid and this.keyDefinitionUri <> ""
+        this.keyGrid.keyDefinitionUri = this.keyDefinitionUri
+    end if
+End Sub
+
+Sub jumpToKeyChanged()
+    this = m.top
+    if this.jumpToKey <> invalid
+        this.keyGrid.jumpToKey = this.jumpToKey
+        this.keyGrid.visible = false
+        this.keyGrid.visible = true
+    end if
+End Sub
+
+Sub disableKeyChanged()
+    this = m.top
+    if this.disableKey <> invalid
+        this.keyGrid.disableKey = this.disableKey
+        this.keyGrid.visible = false
+        this.keyGrid.visible = true
+    end if
+End Sub
+
+Sub enableKeyChanged()
+    this = m.top
+    if this.enableKey <> invalid
+        this.keyGrid.enableKey = this.enableKey
+        this.keyGrid.visible = false
+        this.keyGrid.visible = true
+    end if
+End Sub
+
+Sub focusVisibleChanged()
+    this = m.top
+    if this.focusVisible <> invalid
+        this.keyGrid.focusVisible = this.focusVisible
+    end if
+End Sub
+
+Sub horizWrapChanged()
+    this = m.top
+    if this.horizWrap <> invalid
+        this.keyGrid.horizWrap = this.horizWrap
+    end if
+End Sub
+
+Sub vertWrapChanged()
+    this = m.top
+    if this.vertWrap <> invalid
+        this.keyGrid.vertWrap = this.vertWrap
+    end if
+End Sub
+
+Sub paletteChanged()
+    this = m.top
+    if this.palette <> invalid
+        this.keyGrid.palette = this.palette
+    end if
+End Sub
+
+function getCurrentDateTime(utc = false as Boolean) as Object
+    localDateTime = CreateObject("roDateTime")
+    if utc = false then
+        localDateTime.ToLocalTime()
+    end if
+    strLocalDate = localDateTime.ToISOString()
+
+    return [Left(strLocalDate, 10), Left(Right(strLocalDate, 9), 8)]
+end function
+
+Sub applyInitText()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.initText <> invalid
+        this.text = this.initText
+        textEditBox.text = this.text
+        textEditBox.cursorPosition = this.text.len()
+    end if
+End Sub
+
+Sub textChanged(event as Object)
+    this = m.top
+    textEditBox = this.textEditBox
+    currentText = this.text
+    
+    textLengthChange = currentText.len()
+
+    ' Address-form KDF logic (e.g. CustomAddressKDF): month/year modes auto-format
+    ' date segments. Not a general CustomKeyboard feature — other KDFs with
+    ' month/year mode names may need different behavior.
+    if this.mode = "month" and textLengthChange = 1 then
+        this.text = "0" + currentText
+    end if
+
+    if this.mode = "year" then
+       yearFirstTwoChars = Left(getCurrentDateTime()[0], 2)
+        if textLengthChange = 2 and Val(this.text) <> Val(yearFirstTwoChars) then
+            this.text = yearFirstTwoChars + this.text
+        end if
+    end if
+
+    this.textEditBox.text = this.text
+    this.textEditBox.cursorPosition = this.text.len()
+End Sub
+
+Sub disableVoiceUnderscoreControlChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.disableVoiceUnderscoreControl <> invalid
+        textEditBox.disableVoiceUnderscoreControl = this.disableVoiceUnderscoreControl
+    end if
+End Sub
+
+Sub showUnderscoresChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.showUnderscores <> invalid
+        textEditBox.showUnderscores = this.showUnderscores
+    end if
+End Sub
+
+Sub centerUnderscoresChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.centerUnderscores <> invalid
+        textEditBox.centerUnderscores = this.centerUnderscores
+    end if
+End Sub
+
+Sub maxTextLengthChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.maxTextLength <> invalid
+        textEditBox.maxTextLength = this.maxTextLength
+    end if
+End Sub
+
+Sub voiceEnabledChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.voiceEnabled <> invalid
+        textEditBox.voiceEnabled = this.voiceEnabled
+    end if
+End Sub
+
+Sub voiceEntryTypeChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.voiceEntryType <> invalid
+        textEditBox.voiceEntryType = this.voiceEntryType
+    end if
+End Sub
+
+Sub voiceToolTipWidthChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.voiceToolTipWidth <> invalid
+        textEditBox.voiceToolTipWidth = this.voiceToolTipWidth
+    end if
+End Sub
+
+Sub voiceInputRegexFilterChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.voiceInputRegexFilter <> invalid
+        textEditBox.voiceInputRegexFilter = this.voiceInputRegexFilter
+    end if
+End Sub
+
+Sub hintTextChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.hintText <> invalid
+        textEditBox.hintText = this.hintText
+    end if
+End Sub
+
+Sub cursorPositionChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.cursorPosition <> invalid
+        textEditBox.cursorPosition = this.cursorPosition
+    end if
+End Sub
+
+Sub clearOnDownKeyChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.clearOnDownKey <> invalid
+        textEditBox.clearOnDownKey = this.clearOnDownKey
+    end if
+End Sub
+
+Sub activeChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.active <> invalid
+        textEditBox.active = this.active
+    end if
+End Sub
+
+Sub secureModeChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.secureMode <> invalid
+        textEditBox.secureMode = this.secureMode
+    end if
+End Sub
+
+Sub textColorChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.textColor <> invalid and this.textColor <> ""
+        textEditBox.textColor = this.textColor
+    end if
+End Sub
+
+Sub hintTextColorChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.hintTextColor <> invalid and this.hintTextColor <> ""
+        textEditBox.hintTextColor = this.hintTextColor
+    end if
+End Sub
+
+Sub voiceTextBoxWidthChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.voiceTextBoxWidth <> invalid
+        textEditBox.width = this.voiceTextBoxWidth
+    end if
+End Sub
+
+Sub backgroundUriChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.backgroundUri <> invalid
+        textEditBox.backgroundUri = this.backgroundUri
+    end if
+End Sub
+
+Sub leadingEllipsisChanged()
+    this = m.top
+    textEditBox = this.textEditBox
+    if this.leadingEllipsis <> invalid
+        textEditBox.leadingEllipsis = this.leadingEllipsis
+    end if
+End Sub
+
+function isCapsModifierKey(key as string) as boolean
+    return LCase(key).StartsWith("caps")
+end function
+
+' Register mod keys (abc123 / symbols / accents) in KDFs such as WifiCustomKDF only
+' swap the visible key grid, so suppress strOut and let the app choose the mode.
+function isRegisterModifierKey(key as string) as boolean
+    lk = LCase(key)
+    return lk = "abc123" or lk = "symbols" or lk = "accents"
+end function
+
+Function keySelected(key as string) as boolean
+    this = m.top
+    if isCapsModifierKey(key) or isRegisterModifierKey(key)
+        m.top.SetField("keySelectedValue", {"key": key})
+        return true
+    end if
+
+    if key = "ChangeCase" or key = "Next" or key = "Prev" or key = "ToggleLang"
+        m.top.SetField("keySelectedValue", {"key": key})
+        return true
+    end if
+
+    ' Address-form KDF: month/year modes replace text on each key press.
+    if m.top.keyGrid.mode = "year" or m.top.keyGrid.mode = "month" then
+        m.top.textEditBox.text = key
+        m.top.SetField("keySelectedValue", {"key": key})
+        return true
+    end if
+
+    m.top.SetField("keySelectedValue", {"key": key})
+    return false
+End Function

package/src/xml-components/keyboards/CustomKeyboard.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<component name="CustomKeyboard" extends="DynamicCustomKeyboard">
+    <script type="text/brightscript" uri="CustomKeyboard.brs" />
+    <interface>
+        <field id="voiceEnabled" type="boolean" value="false" onChange="voiceEnabledChanged" />
+        <field id="voiceToolTipWidth" type="float" onChange="voiceToolTipWidthChanged" />
+        <field id="voiceEntryType" type="string" onChange="voiceEntryTypeChanged" />
+        <field id="voiceInputRegexFilter" type="string" onChange="voiceInputRegexFilterChanged" />
+        <field id="isDictating" type="boolean" alwaysNotify="true" />
+        <field id="hintText" type="string" onChange="hintTextChanged" />
+        <field id="maxTextLength" type="float" onChange="maxTextLengthChanged" />
+        <field id="cursorPosition" type="float" onChange="cursorPositionChanged" />
+        <field id="clearOnDownKey" type="boolean" onChange="clearOnDownKeyChanged" />
+        <field id="active" type="boolean" onChange="activeChanged" />
+        <field id="secureMode" type="boolean" onChange="secureModeChanged" />
+        <field id="textColor" type="string" onChange="textColorChanged" />
+        <field id="hintTextColor" type="string" onChange="hintTextColorChanged" />
+        <field id="voiceTextBoxWidth" type="float" onChange="voiceTextBoxWidthChanged" />
+        <field id="backgroundUri" type="string" onChange="backgroundUriChanged" />
+        <field id="leadingEllipsis" type="boolean" onChange="leadingEllipsisChanged" />
+
+        <field id="disableVoiceUnderscoreControl" type="boolean"
+            onChange="disableVoiceUnderscoreControlChanged" />
+        <field id="showUnderscores" type="boolean" onChange="showUnderscoresChanged" />
+        <field id="centerUnderscores" type="boolean" onChange="centerUnderscoresChanged" />
+
+        <field id="keyDefinitionUri" type="string" onChange="keyDefinitionUriChanged" />
+        <field id="mode" type="string" onChange="modeChanged" />
+        <field id="jumpToKey" type="floatarray" onChange="jumpToKeyChanged" />
+        <field id="disableKey" type="string" onChange="disableKeyChanged" />
+        <field id="enableKey" type="string" onChange="enableKeyChanged" />
+        <field id="focusVisible" type="boolean" onChange="focusVisibleChanged" />
+        <field id="horizWrap" type="boolean" onChange="horizWrapChanged" />
+        <field id="vertWrap" type="boolean" onChange="vertWrapChanged" />
+        <field id="palette" type="node" onChange="paletteChanged" />
+        <field id="keySelectedValue" type="assocarray" />
+        <field id="initText" type="string" onChange="initTextChanged" />
+
+        <function name="keySelected" />
+        <field id="next" type="bool" alwaysNotify="true" />
+        <field id="prev" type="bool" alwaysNotify="true" />
+    </interface>
+
+</component>

package/src/xml-components/keyboards/CustomKeyboard.xml.d.ts

@@ -0,0 +1,73 @@
+// Auto-generated TypeScript declarations for XML component import.
+// DO NOT EDIT — this file is regenerated during build.
+//
+// Source component: CustomKeyboard
+// Extends: DynamicCustomKeyboard
+
+import type { IKeyboardPropsWithVoice } from "@roku-sdk/components";
+import type { TypedXmlComponent } from "@roku-sdk/interfaces";
+
+interface CustomKeyboardFields {
+    /** @default "false" */
+    voiceEnabled: boolean;
+    voiceToolTipWidth: number;
+    voiceEntryType: string;
+    voiceInputRegexFilter: string;
+    isDictating: boolean;
+    hintText: string;
+    maxTextLength: number;
+    cursorPosition: number;
+    clearOnDownKey: boolean;
+    active: boolean;
+    secureMode: boolean;
+    textColor: string;
+    hintTextColor: string;
+    voiceTextBoxWidth: number;
+    backgroundUri: string;
+    leadingEllipsis: boolean;
+    disableVoiceUnderscoreControl: boolean;
+    showUnderscores: boolean;
+    centerUnderscores: boolean;
+    keyDefinitionUri: string;
+    mode: string;
+    jumpToKey: number[];
+    disableKey: string;
+    enableKey: string;
+    focusVisible: boolean;
+    horizWrap: boolean;
+    vertWrap: boolean;
+    palette: import("@roku-sdk/interfaces").DomNode;
+    keySelectedValue: Record<string, unknown>;
+    initText: string;
+    next: boolean;
+    prev: boolean;
+}
+
+export interface ICustomKeyboardProps extends IKeyboardPropsWithVoice, Partial<CustomKeyboardFields> {}
+
+declare const _default: TypedXmlComponent<"CustomKeyboard", CustomKeyboardFields>;
+export default _default;
+
+declare module "@roku-sdk/solid" {
+    namespace JSX {
+        interface IntrinsicElements {
+            customKeyboard: ICustomKeyboardProps;
+        }
+    }
+}
+
+declare module "@roku-sdk/solid/jsx-runtime" {
+    namespace JSX {
+        interface IntrinsicElements {
+            customKeyboard: ICustomKeyboardProps;
+        }
+    }
+}
+
+declare module "solid-js" {
+    namespace JSX {
+        interface IntrinsicElements {
+            customKeyboard: ICustomKeyboardProps;
+        }
+    }
+}

package/src/xml-components/keyboards/KeyGridExt.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<component name="KeyGridExt" extends="DynamicKeyGrid">
+</component>

package/src/xml-components/keyboards/KeyGridExt.xml.d.ts

@@ -0,0 +1,37 @@
+// Auto-generated TypeScript declarations for XML component import.
+// DO NOT EDIT — this file is regenerated during build.
+//
+// Source component: KeyGridExt
+// Extends: DynamicKeyGrid
+
+import type { IDynamicKeyGridProps } from "@roku-sdk/components";
+import type { TypedXmlComponent } from "@roku-sdk/interfaces";
+
+export interface IKeyGridExtProps extends IDynamicKeyGridProps {}
+
+declare const _default: TypedXmlComponent<"KeyGridExt", Record<string, never>>;
+export default _default;
+
+declare module "@roku-sdk/solid" {
+    namespace JSX {
+        interface IntrinsicElements {
+            keyGridExt: IKeyGridExtProps;
+        }
+    }
+}
+
+declare module "@roku-sdk/solid/jsx-runtime" {
+    namespace JSX {
+        interface IntrinsicElements {
+            keyGridExt: IKeyGridExtProps;
+        }
+    }
+}
+
+declare module "solid-js" {
+    namespace JSX {
+        interface IntrinsicElements {
+            keyGridExt: IKeyGridExtProps;
+        }
+    }
+}

package/src/xml-components/keyboards/KeyboardExt.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<component name="KeyboardExt" extends="DynamicKeyboard">
+</component>

package/src/xml-components/keyboards/KeyboardExt.xml.d.ts

@@ -0,0 +1,37 @@
+// Auto-generated TypeScript declarations for XML component import.
+// DO NOT EDIT — this file is regenerated during build.
+//
+// Source component: KeyboardExt
+// Extends: DynamicKeyboard
+
+import type { IDynamicKeyboardProps } from "@roku-sdk/components";
+import type { TypedXmlComponent } from "@roku-sdk/interfaces";
+
+export interface IKeyboardExtProps extends IDynamicKeyboardProps {}
+
+declare const _default: TypedXmlComponent<"KeyboardExt", Record<string, never>>;
+export default _default;
+
+declare module "@roku-sdk/solid" {
+    namespace JSX {
+        interface IntrinsicElements {
+            keyboardExt: IKeyboardExtProps;
+        }
+    }
+}
+
+declare module "@roku-sdk/solid/jsx-runtime" {
+    namespace JSX {
+        interface IntrinsicElements {
+            keyboardExt: IKeyboardExtProps;
+        }
+    }
+}
+
+declare module "solid-js" {
+    namespace JSX {
+        interface IntrinsicElements {
+            keyboardExt: IKeyboardExtProps;
+        }
+    }
+}

package/src/xml-components/keyboards/MOPPinPadCustomKDF.keyboard.json

@@ -0,0 +1,151 @@
+{
+    "keyboardWidthFHD": 495,
+    "keyboardHeightFHD": 350,
+    "keyboardWidthHD": 324,
+    "keyboardHeightHD": 240,
+    "sections": [
+        {
+            "grids": [
+                {
+                    "modes": "card",
+                    "rows": [
+                        {
+                            "keys": [{ "label": "1" }, { "label": "2" }, { "label": "3" }]
+                        },
+                        {
+                            "keys": [{ "label": "4" }, { "label": "5" }, { "label": "6" }]
+                        },
+                        {
+                            "keys": [{ "label": "7" }, { "label": "8" }, { "label": "9" }]
+                        },
+                        {
+                            "keys": [
+                                {
+                                    "icon": "theme:DKB_ClearKeyBitmap",
+                                    "focusIcon": "theme:DKB_ClearKeyFocusBitmap",
+                                    "strOut": "clear"
+                                },
+                                { "label": "0" },
+                                {
+                                    "icon": "theme:DKB_DeleteKeyBitmap",
+                                    "focusIcon": "theme:DKB_DeleteKeyFocusBitmap",
+                                    "autoRepeat": 1,
+                                    "strOut": "backspace"
+                                }
+                            ]
+                        },
+                        {
+                            "keys": [{ "label": "Prev", "disabled": 1 }, { "label": "Next" }]
+                        }
+                    ]
+                },
+                {
+                    "modes": "month",
+                    "rows": [
+                        {
+                            "keys": [{ "label": "01" }, { "label": "02" }, { "label": "03" }]
+                        },
+                        {
+                            "keys": [{ "label": "04" }, { "label": "05" }, { "label": "06" }]
+                        },
+                        {
+                            "keys": [{ "label": "07" }, { "label": "08" }, { "label": "09" }]
+                        },
+                        {
+                            "keys": [{ "label": "10" }, { "label": "11" }, { "label": "12" }]
+                        },
+                        {
+                            "keys": [{ "label": "Prev" }, { "label": "Next" }]
+                        }
+                    ]
+                },
+                {
+                    "modes": "year",
+                    "rows": [
+                        {
+                            "keys": [{ "label": "2022" }, { "label": "2023" }, { "label": "2024" }]
+                        },
+                        {
+                            "keys": [{ "label": "2025" }, { "label": "2026" }, { "label": "2027" }]
+                        },
+                        {
+                            "keys": [{ "label": "2028" }, { "label": "2029" }, { "label": "2030" }]
+                        },
+                        {
+                            "keys": [{ "label": "2031" }, { "label": "2032" }, { "label": "2033" }]
+                        },
+                        {
+                            "keys": [{ "label": "Prev" }, { "label": "Next" }]
+                        }
+                    ]
+                },
+                {
+                    "modes": "cvv",
+                    "rows": [
+                        {
+                            "keys": [{ "label": "1" }, { "label": "2" }, { "label": "3" }]
+                        },
+                        {
+                            "keys": [{ "label": "4" }, { "label": "5" }, { "label": "6" }]
+                        },
+                        {
+                            "keys": [{ "label": "7" }, { "label": "8" }, { "label": "9" }]
+                        },
+                        {
+                            "keys": [
+                                {
+                                    "icon": "theme:DKB_ClearKeyBitmap",
+                                    "focusIcon": "theme:DKB_ClearKeyFocusBitmap",
+                                    "strOut": "clear"
+                                },
+                                { "label": "0" },
+                                {
+                                    "icon": "theme:DKB_DeleteKeyBitmap",
+                                    "focusIcon": "theme:DKB_DeleteKeyFocusBitmap",
+                                    "autoRepeat": 1,
+                                    "strOut": "backspace"
+                                }
+                            ]
+                        },
+                        {
+                            "keys": [{ "label": "Prev" }, { "label": "Next" }]
+                        }
+                    ]
+                },
+                {
+                    "modes": "zip",
+                    "rows": [
+                        {
+                            "keys": [{ "label": "1" }, { "label": "2" }, { "label": "3" }]
+                        },
+                        {
+                            "keys": [{ "label": "4" }, { "label": "5" }, { "label": "6" }]
+                        },
+                        {
+                            "keys": [{ "label": "7" }, { "label": "8" }, { "label": "9" }]
+                        },
+                        {
+                            "keys": [
+                                {
+                                    "icon": "theme:DKB_ClearKeyBitmap",
+                                    "focusIcon": "theme:DKB_ClearKeyFocusBitmap",
+                                    "strOut": "clear"
+                                },
+                                { "label": "0" },
+                                {
+                                    "icon": "theme:DKB_DeleteKeyBitmap",
+                                    "focusIcon": "theme:DKB_DeleteKeyFocusBitmap",
+                                    "autoRepeat": 1,
+                                    "strOut": "backspace"
+                                }
+                            ]
+                        },
+                        {
+                            "keys": [{ "label": "Prev" }, { "label": "Next" }]
+                        }
+                    ]
+                }
+            ]
+        }
+    ]
+}

package/src/xml-components/keyboards/MiniKeyboardExt.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<component name="MiniKeyboardExt" extends="DynamicMiniKeyboard">
+</component>