TextInput

View source
spec.TextInput (Interface) → backend.TextInput

Backend interface for system text input handling.

This interface manages platform-specific text input methods including virtual keyboards on mobile devices and IME (Input Method Editor) support for international text entry.

When text input is started, the backend should show the appropriate input UI (virtual keyboard, IME window, etc.) and send text events to the application. The position and size parameters help the platform position the input UI appropriately.

Text input events are dispatched through the App's event system.

Instance Members

start(initialText: String, x: Float, y: Float, w: Float, h: Float): Void

Starts text input mode with the system input method.

This typically shows a virtual keyboard on mobile devices or activates the IME on desktop platforms. The position parameters help the system avoid covering the input field with the keyboard.

Name Type Description
initialText String The initial text to display in the input field
x Float The X position of the input field in screen coordinates
y Float The Y position of the input field in screen coordinates
w Float The width of the input field
h Float The height of the input field
stop(): Void

Stops text input mode and hides the system input method.

This hides the virtual keyboard or deactivates the IME. Should be called when text input is no longer needed.